/v1/oauth/introspect

POST {{baseUrl}}/v1/oauth/introspect

Introspect an access token to see whether it is valid and active. You can also verify some token properties, such as its claims, scopes, and validity times.

Requests to this endpoint require authentication with your client ID and client secret, using one of the following methods:

  • Basic access authentication (Recommended): For basic access authentication, the {credentials} string must be a Base64 encoded value of {client id}:{client secret}.
  • Body parameters: Provide your integration's credentials using the client_id and client_secret body parameters.

Request Body

[{"name"=>"token", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"client_id", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"client_secret", "value"=>"<string>", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;scope&quot;:&quot;\u003cstring\u003e&quot;,&quot;client&quot;:&quot;\u003cstring\u003e&quot;,&quot;exp&quot;:&quot;\u003clong\u003e&quot;,&quot;iat&quot;:&quot;\u003clong\u003e&quot;,&quot;nbf&quot;:&quot;\u003clong\u003e&quot;,&quot;jti&quot;:&quot;\u003cstring\u003e&quot;,&quot;sub&quot;:&quot;\u003cstring\u003e&quot;}