Get Token Introspection Details Using POST
The 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 | ✔️ | ✔️ |
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.
The application/x-www-form-urlencoded form data type.
The token to be introspected.
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.
"TokenIntrospectionResponse Object"The timestamp the token expires at (measured in number of seconds since 1/1/1970 UTC).
Unique identifier (GUID) of the organization.
The type of the token.
Indicator of whether or not the presented token is currently active.
The timestamp the token was created at (measured in number of seconds since 1/1/1970 UTC).
The unique identifier of the user, on behalf of which the token was issued.
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.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The requested resource could not be found
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The request could not be processed due to a conflict
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/x-www-form-urlencoded' -d '{"token:"string"}' https://{api_host}/csp/gateway/am/api/auth/introspect