XExenforo-ltd
OAuth2

Introspect an OAuth token

Changed on

Introspect an OAuth token.

post/oauth2/introspect

Request

Request body application/x-www-form-urlencoded

client_idstring required
client_secretstring required
tokenstring required
token_type_hintstring

Either 'access_token' or 'refresh_token'

Response

OK

activeboolean

Whether the token is currently active

scopestring

Space-separated list of scopes

Note Conditionally returned

client_idstring

The client that the token was issued to

Note Conditionally returned

usernamestring

The user associated with the token

Note Conditionally returned

token_typestring

Either 'bearer' or 'refresh_token'

Note Conditionally returned

expinteger

Expiry timestamp

Note Conditionally returned

iatinteger

Issue timestamp

Note Conditionally returned

substring

Subject (user ID)

Note Conditionally returned

issstring

Issuer (board URL)

Note Conditionally returned

Changes

  • e271d0e41f6dRevision changes
    • breaking

      request body became required

    • breaking

      removed the media type application/json from the request body

    • info

      api operation id post_oauth2_introspect removed and replaced with postOauth2Introspect

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

  • 61b60b0c0d52Revision changes
    • info

      endpoint added