Sign in
OAuth2

Introspect an OAuth token

Introspect an OAuth token.

post/oauth2/introspect

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

Changed in 3 of the 7 revisions of this API.34

  • e271d0e41f6d23See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

      removed the media type application/json from the request body

      request-body-media-type-removed

    • ○

      api operation id post_oauth2_introspect removed and replaced with postOauth2Introspect

      api-operation-id-removed

    • ○

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

      new-optional-request-default-parameter-to-existing-path

    • ○

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

      new-optional-request-default-parameter-to-existing-path

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 61b60b0c0d521See the full diff
    • ○

      endpoint added

      endpoint-added

  • fc0a40f3b8591See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog