Get OAuth user info

Retrieves user information based on the access token passed in the authorization header

GET/{apiBasePath}/oauth/userinfo

Authorization

AuthorizationBearer token · headerrequired

An OAuth2 access token returned by the token or authorization endpoints during OAuth flows

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Responses

200Retrieved user information

One of:

object

subuserIdrequired

Unique identifier for a user

emailstring

The email of the user

email_verifiedboolean

Whether the email is verified

emailsstring[]

phoneNumberstring

The phoneNumber of the user

phoneNumber_verifiedboolean

Whether the phoneNumber is verified

phoneNumbersstring[]

rolesstring[]

permissionsstring[]

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

401The access token is expired, revoked or malformed

messagestring

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the user

Request

curl -X GET "/auth/oauth/userinfo" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/auth/oauth/userinfo", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/auth/oauth/userinfo",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "sub": "fa7a0841-b533-4478-95533-0fde890c3483",
  "email": "[email protected]",
  "email_verified": true,
  "emails": [
    "[email protected]"
  ],
  "phoneNumber": "0036701234567",
  "phoneNumber_verified": true,
  "phoneNumbers": [
    "0036701234567"
  ],
  "roles": [
    "admin"
  ],
  "permissions": [
    "user:create"
  ]
}

{
  "message": "Invalid or expired OAuth2 access token"
}

"Not Found"

"Internal Error"