Get Token Introspection Details
DescriptionThe call is protected by HTTP Basic authentication with client_id and client_secret. Note: when using Public OAuth clients, Authorization is required using the format ‘Basic Base64_Encode(client_id:)’ with empty client_secret. This endpoint follows the token introspection specifications defined in https://tools.ietf.org/html/rfc7662. Only introspection of refresh tokens is supported. Include the parameter using application/x-www-form-urlencoded format in the HTTP request body.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Anonymous | ✔️ | ✔️ |
Request
URLURL
Header Parameters
Header Parameters
Basic auth with client credentials [Basic Base64_Encode(client_id:client_secret)] Note: when using Public OAuth clients, Authorization is required using the format ‘Basic Base64_Encode(client_id:)’ with empty client_secret.
Request Body
The application/x-www-form-urlencoded form data type.
{
"token": "string"
}
The token to be introspected.
Authentication
Response
Response BodyResponse Body
200 OK
JSON object representing the refresh token’s information. The ‘active’ top-level member will indicate whether or not the presented token is currently active. If active, additional members will be present in the response.
{
"active": false,
"exp": 0,
"iat": 0,
"orgId": "string",
"sub": "string",
"token_type": "string"
}
Indicator of whether or not the presented token is currently active.
The timestamp the token expires at (measured in number of seconds since 1/1/1970 UTC).
The timestamp the token was created at (measured in number of seconds since 1/1/1970 UTC).
Unique identifier (GUID) of the organization.
The unique identifier of the user, on behalf of which the token was issued.
The type of the token.
Errors
Authorization header must be specified | Invalid authorization header. Missing “Basic” prefix | Invalid authorization header | Bad Request - Client ID in path doesn’t match the Client ID in the Basic Authorization Header.
The requested resource could not be found
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
