Introspect an OAuth token.

POST

/introspect

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/introspect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data token=example \
  --data token_type_hint=example

Returns active token metadata only for an Authrim access or refresh token when the authenticated client owns the token or is named by the token’s signed audience or resource claim. ID tokens and other signed protocol JWTs are reported as inactive.

Authorizations

• clientAuth

Request Body ^required

Media type application/x-www-form-urlencoded

object

token

string

token_type_hint

string

key

additional properties

Example ^generated

token=example&token_type_hint=example

Responses

200

Successful JSON response.

Media type application/json

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}

401

OAuth error response.

Media type application/json

object

error

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "error_description": "example"
}