Jump to

• Request
• Response

Validate the Token

post

/oauth2/v1/introspect

Request

Supported Media Types

• application/x-www-form-urlencoded

Header Parameters

• Authorization: string
  Basic Authorization. Base64 encoding of client credentials

Body ()

Root Schema : schema

Type: object

Show Source

• token: string
  Access Token

  Example: eyJ4NXQiOiI4Wk5NMEFfNWFuSTc0dGp3Y3FWcWtMN3Z0Q2ciLCJraWQiOiJwcml2YWVrZXkxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJuYmYiOjE0NDA3NTk0MDgsInNjb3BlIjoiQUNNRUNhbmRpZGF0ZVByb2ZpbGVTZXJ2aWNlLnJlc3VtZXNfbW9udGhzIG9mZmxpbmVfYWNjZXNzIiwiaXNzIjoiaWRjcy5vcmFjbGUuY29tIiwiZXhwIjoxNDQwNzYzMDA4LCJpYXQiOjE0NDA3NTk0MDgsInRlbmFudCI6IlRFTkFOVDEiLCJqdGkiOiI0MGU2MjU1ZS1lOGVhLTQ5ZTYtYmVlYy03ZjgwMzdkZDM3YTAifQ.OyDEHQB_RHEaeHjKak7coN1w-wsJjH_1a0ehu8h7pKE7uGJLB6fWWHzCMfLk9eXNb_eUvuNNGB7sx7TlRKHFpw

{
    "type":"object",
    "properties":{
        "token":{
            "description":"Access Token",
            "type":"string",
            "example":"eyJ4NXQiOiI4Wk5NMEFfNWFuSTc0dGp3Y3FWcWtMN3Z0Q2ciLCJraWQiOiJwcml2YWVrZXkxIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI1YzA4NDcyMi03Njk3LTQ2NzgtOWVmNC01ZDMxYjg5MjgzYTMiLCJuYmYiOjE0NDA3NTk0MDgsInNjb3BlIjoiQUNNRUNhbmRpZGF0ZVByb2ZpbGVTZXJ2aWNlLnJlc3VtZXNfbW9udGhzIG9mZmxpbmVfYWNjZXNzIiwiaXNzIjoiaWRjcy5vcmFjbGUuY29tIiwiZXhwIjoxNDQwNzYzMDA4LCJpYXQiOjE0NDA3NTk0MDgsInRlbmFudCI6IlRFTkFOVDEiLCJqdGkiOiI0MGU2MjU1ZS1lOGVhLTQ5ZTYtYmVlYy03ZjgwMzdkZDM3YTAifQ.OyDEHQB_RHEaeHjKak7coN1w-wsJjH_1a0ehu8h7pKE7uGJLB6fWWHzCMfLk9eXNb_eUvuNNGB7sx7TlRKHFpw"
        }
    },
    "required":[
        "token"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Access Token validated

Body ()

Root Schema : introspect

Type: object

Validate the token

Show Source

• active: string
  Active status of the Access Token
• exp: number
  Expiry time of the Access Token
• iat: number
  Issue time of the Access Token
• iss: string
  Issuer of the Access Token
• nbf: number
  Not before in Access Token
• preferred_username: string
  Preferred User Name
• prn: string
  Principal of the Access Token
• scope: string
  Scope provided in the Access Token
• token_type: string
  Token type

{
    "description":"Validate the token",
    "type":"object",
    "properties":{
        "token_type":{
            "type":"string",
            "description":"Token type"
        },
        "iat":{
            "type":"number",
            "description":"Issue time of the Access Token"
        },
        "iss":{
            "type":"string",
            "description":"Issuer of the Access Token"
        },
        "nbf":{
            "type":"number",
            "description":"Not before in Access Token"
        },
        "exp":{
            "type":"number",
            "description":"Expiry time of the Access Token"
        },
        "scope":{
            "type":"string",
            "description":"Scope provided in the Access Token"
        },
        "prn":{
            "type":"string",
            "description":"Principal of the Access Token"
        },
        "active":{
            "type":"string",
            "description":"Active status of the Access Token"
        },
        "preferred_username":{
            "type":"string",
            "description":"Preferred User Name"
        }
    },
    "required":[
        "token_type",
        "iat",
        "iss",
        "nbf",
        "exp",
        "scope",
        "prn",
        "active",
        "preferred_username"
    ]
}

400 Response

Invalid request

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

401 Response

Invalid client

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

Back to Top