Sign in
Token

The Introspection OAuth 2 Endpoint.

The Introspection OAuth 2 Endpoint.

get/restv1/introspection

Query parameters

tokenstring required
token_type_hintstring

ID Token previously issued by the Authorization Server being passed as a hint about the End-User.

response_as_jwtboolean

OPTIONAL. Boolean value with default value false. If true, returns introspection response as JWT (signed based on client configuration used for authentication to Introspection Endpoint).

Headers

Authorizationstring required

Client Authorization details that contains the access token along with other details.

Response

OK

activeboolean required

Boolean indicator of whether or not the presented token is currently active.

scopestring[]

Provide list of scopes to which access was granted for this resource.

client_idstring

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

usernamestring

Human-readable identifier for the resource owner who authorized this token.

token_typestring

Type of the token as defined in Section 5.1 of OAuth 2.0 [RFC6749].

expinteger

Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this permission will expire.

iatinteger
substring

Subject of the token, as defined in JWT [RFC7519].

audstring

Service-specific string identifier or list of string identifiers representing the intended audience for this token, as defined in JWT [RFC7519].

issstring

String representing the issuer of this token, as defined in JWT [RFC7519].

acr_valuesstring

Authentication Context Class Reference values.

jtistring

String identifier for the token, as defined in JWT.

Example response

{
  "active": true,
  "scope": [
    "read write dolphin"
  ],
  "client_id": "1238j323ds-23ij4",
  "username": "jdoe",
  "token_type": "bearer, mac",
  "sub": "Z5O3upPC88QrAjx00dis",
  "aud": "https://protected.example.net/resource",
  "iss": "https://server.example.com/"
}

Changes

Changed in 2 of the 51 revisions of this API.11