Jump to

• Request
• Response

Generate Authorization Code and Identity Token (3-legged OAuth Flow)

get

/oauth2/v1/authorize

Request

Supported Media Types

• application/json

Query Parameters

• client_id: string
  Unique ID of the client
• nonce(optional): string
  Value that associates the client session with the ID Token and is used to mitigate replay attacks
• redirect_uri: string
  Redirection URI where the response is sent
• response_type: string
  Type of response from the server (code/token/id_token)
• scope: string
  Scope for which the Access Token is requested
• state(optional): string
  Opaque value used to maintain the state between the request and the callback

Back to Top

Response

Supported Media Types

• application/json

200 Response

Authorization Code generated

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

Unauthorized 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"
    ]
}

500 Response

Internal Server Error

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