Get Access Token With Authorization Request

Use this API instead:

/oidc/oauth2/token

Exchange authorization code, refresh token or ~~client_credentials~~ to user access token.

Access Policy

Role	Access
Anonymous	✔️

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/csp/gateway/am/api/auth/authorize

COPY

Header Parameters

string

authorization

Optional

authorization

Request Body

AuthorizationRequest of type(s) application/json

Optional

Show optional properties

{
    "grant_type": "string",
    "state": "string"
}

{
    "grant_type": "string",
    "refresh_token": "string",
    "code": "string",
    "state": "string",
    "redirect_uri": "string",
    "client_id": "string",
    "client_secret": "string",
    "scope": "string",
    "orgId": "string"
}

string

grant_type

Required

The type of authorization to be performed.

string

refresh_token

Optional

The refresh token when grant_type is set to refresh_token

string

code

Optional

The authorization code when grant_type is set to authorization_code

string

state

Required

A transparent state of the request.

string

redirect_uri

Optional

The URI to which a redirect will be performed upon successful authorization.

string

client_id

Optional

The client ID when grant_type is set to client_credentials. Will be ignored if the Authorization header is set.

string

client_secret

Optional

The client secret when grant_type is set to client_credentials. Will be ignored if the Authorization header is set.

string

scope

Optional

Currently not supported. Present for CSP compatibility.

string

orgId

Optional

When grant_type is set to client_credentials if this parameter is set the issued token will be limited to the specified organization.

Authentication

This operation uses the following authentication methods.

BearerAuth

BasicAuth

Responses

200

Returns AccessToken of type(s) */*

"AccessToken Object"

string

scope

Optional

Scope

string

access_token

Optional

Access Token

string

refresh_token

Optional

Refresh Token

string

id_token

Optional

ID Token

string

token_type

Optional

Token Type

integer As int64 As int64

expires_in

Optional

Access Token Expiration

400

Invalid request body.

Returns AccessToken of type(s) */*

"AccessToken Object"

string

scope

Optional

Scope

string

access_token

Optional

Access Token

string

refresh_token

Optional

Refresh Token

string

id_token

Optional

ID Token

string

token_type

Optional

Token Type

integer As int64 As int64

expires_in

Optional

Access Token Expiration

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"grant_type:"string","state:"string"}' https://{api_host}/csp/gateway/am/api/auth/authorize

Deprecated

On This Page

Description

Request

Header Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Authentication Controller Operations

POST