PRproof
OAuth 2.0

Introspect a Token

Returns the state of a token, per RFC 7662. Callers authenticate as the client the token was issued to, or as the protected resource the token was issued for, with client_secret_post, client_secret_basic, private_key_jwt or a Bearer token. Expired, revoked and unknown tokens return active: false.

post/oauth/v2/introspect

Request

  • Base URL
    https://api.proof.com
  • URL
    https://api.proof.com/oauth/v2/introspect
  • Auth
    none declared

Request body application/x-www-form-urlencoded

tokenstring required

The token to introspect.

token_type_hint'access_token' | 'refresh_token'

A token_type_hint for the submitted token.

client_idstring

Your client_id.

client_secretstring

Your client secret, for client_secret_post client authentication.

client_assertion_type'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'

Set to urn:ietf:params:oauth:client-assertion-type:jwt-bearer for private_key_jwt client authentication.

client_assertionstring

A JWT signed with one of your registered keys, for private_key_jwt client authentication: iss and sub are your client_id, aud is the issuer or the token endpoint URL, with exp and a single-use jti.

Example request

{
  "token": "the-token-to-introspect",
  "client_id": "your-client-id",
  "client_secret": "your-client-secret"
}

Response

successful

activeboolean required

Whether the token is currently active, per the introspection response. false stands alone.

scopestring

Space-separated scope values granted to the token.

client_idstring

The client_id the token was issued to.

token_typestring

Always Bearer.

iatinteger

The iat claim: issue time, as a Unix timestamp in seconds.

expinteger

The exp claim: expiry, as a Unix timestamp in seconds. Present for tokens that expire.

issstring

The iss claim: the authorization server that issued the token.

audstring

The aud claim: the protected resource the token was issued for. Present for resource-bound tokens.

substring

The sub claim: the subject the token was issued for.

sub_typestring

The kind of subject sub identifies.

Changes

No recorded changes to this operation across all 1 revision of this API.