Introspect OAuth token

Introspects an access/refresh token

POST/{apiBasePath}/oauth/introspect

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Request body

application/json

tokenstringrequired

Responses

200Information about the token

One of:

object

activebooleanrequired

Whether the token is active or not

token_typestring

The type of the token

token_usestring

The use of the token

subuserId

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

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

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

Bodyapplication/json

tokenstring*

Request

curl -X POST "/auth/oauth/introspect" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "string"
}'

const response = await fetch("/auth/oauth/introspect", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "token": "string"
})
});

import requests

response = requests.post(
    "/auth/oauth/introspect",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "token": "string"
},
)

Response

{
  "active": true,
  "token_type": "Bearer",
  "token_use": "access_token",
  "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"
  ]
}

"Not Found"

"Internal Error"