Introspect OAuth2 Token

POST/appid-{appId}/recipe/oauth/introspect

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

tokenstringrequired

Responses

200OAuth2 Token Introspection Result

One of:

object

statusstatusOK

Allowed:OK

activeboolean

iatinteger

expinteger

client_idstring

issstring

jtistring

nbfinteger

scpstring[]

substring

sttinteger

sessionHandlestring

rsubstring

tIdstring

gidstring

token_typestring

token_usestring

oauthError

statusstringrequired

Allowed:OAUTH_ERROR

errorstringrequired

errorDescriptionstringrequired

statusCodeintegerrequired

400error code 400

string

401error code 401

string

402error code 402

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

cdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

tokenstring*

Request

curl -X POST "/appid-{appId}/recipe/oauth/introspect" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "token": "string"
}'

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

import requests

response = requests.post(
    "/appid-{appId}/recipe/oauth/introspect",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "token": "string"
},
)

Response

{
  "status": "OK",
  "active": true,
  "iat": 1740992368,
  "exp": 1740995969,
  "client_id": "stcl_fed7cff0-cc6e-406e-b7a6-766148675a4a",
  "iss": "http://localhost:3001/auth",
  "jti": "1c229efe-c55b-44c1-98cf-9fa3a366502e",
  "nbf": 1740992368,
  "scp": [
    "openid",
    "offline_access"
  ],
  "sub": "137d053d-0d69-4dea-8a19-06ddbdfa4f96",
  "stt": 1,
  "sessionHandle": "87bcc2d8-f159-4e10-a097-0898179a2d7d",
  "rsub": "137d053d-0d69-4dea-8a19-06ddbdfa4f96",
  "tId": "public",
  "gid": "575b7130-d982-4945-be49-3ecde2a49eaa",
  "token_type": "Bearer",
  "token_use": "access_token"
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"