Jump to

• Request
• Response
• Examples

Validate Access Token Flow

get

/oauth2/rest/token/info

Request

Supported Media Types

• application/json

Query Parameters

• access_token: string
  Access Token to be validated

Header Parameters

• x-oauth-identity-domain-name: string

Response

Supported Media Types

• application/json

200 Response

Access Token Details

Body ()

Root Schema : AccessTokenDetails

Type: object

Show Source

• aud: string
  Expected Audience
• client: string
  Client ID
• domain: string
  Identity Domain
• exp: integer
  Expires In
• iat: integer
  Issued At
• iss: string
  Issuer
• jti: string
  Identifier
• scope: string
  Allowed Scopes
• sub: string
  Subject

{
    "type":"object",
    "properties":{
        "iss":{
            "type":"string",
            "description":"Issuer"
        },
        "aud":{
            "type":"string",
            "description":"Expected Audience"
        },
        "exp":{
            "type":"integer",
            "description":"Expires In"
        },
        "jti":{
            "type":"string",
            "description":"Identifier"
        },
        "iat":{
            "type":"integer",
            "description":"Issued At"
        },
        "sub":{
            "type":"string",
            "description":"Subject"
        },
        "client":{
            "type":"string",
            "description":"Client ID"
        },
        "scope":{
            "type":"string",
            "description":"Allowed Scopes"
        },
        "domain":{
            "type":"string",
            "description":"Identity Domain"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorCode

Type: object

Show Source

• errorCode: string
  Error Code Generated
• errorDesc: string
  Translated Error Description
• secErrorDesc: string
  Secondary Error Message

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code Generated"
        },
        "errorDesc":{
            "type":"string",
            "description":"Translated Error Description"
        },
        "secErrorDesc":{
            "type":"string",
            "description":"Secondary Error Message"
        }
    }
}

Examples

The following cURL command shows a sample request against the server for validating Access Tokens.

cURL Example

curl -i -H "X-OAUTH-IDENTITY-DOMAIN-NAME: SSOLink" --request GET "http://<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token/info?access_token=<AccessToken>"