Sign in

v1

latestOpenAPI 3.0.02026-07-22243670.8 KB
OAuth

Introspect token

Returns metadata about an access token, including whether it is active.

post/oauth/introspect

Request body

client_idstring

The client identifier.

client_secretstring

The client secret.

tokenstring required

The token to introspect.

Example request

{
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_secret": "my-client-secret",
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response

Token introspection result.

activeboolean required

Whether the token is active.

client_idstring

The client identifier for the OAuth 2.0 client that requested this token.

expinteger

The Unix timestamp when the token expires.

iatinteger

The Unix timestamp when the token was issued.

issstring

The issuer of the token.

scopestring

A space-separated list of scopes associated with the token.

substring

The subject of the token (user ID).

usernamestring

The username of the resource owner.

Example response

{
  "active": true,
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "exp": 1704067200,
  "iat": 1704063600,
  "iss": "https://api.example.com",
  "scope": "read write",
  "sub": "550e8400-e29b-41d4-a716-446655440000",
  "username": "user@example.com"
}