Login Oauth

Login Oauth
Get Access token.

Use this API instead:

  • /oidc/oauth2/token

An alias of the AuthenticationController's get access token method.

Access Policy

Role Access
Anonymous ✔️
Request
URI
POST
https://vcfa-10-162-161-9.vcfd.broadcom.net/csp/gateway/am/api/login/oauth
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.
Responses
200

OK

Returns AccessToken of type(s) */* 
{
    "scope": "string",
    "access_token": "string",
    "refresh_token": "string",
    "id_token": "string",
    "token_type": "string",
    "expires_in": 0
}

400

Invalid request body.

Returns AccessToken of type(s) */* 
{
    "scope": "string",
    "access_token": "string",
    "refresh_token": "string",
    "id_token": "string",
    "token_type": "string",
    "expires_in": 0
}

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/login/oauth
Deprecated
On This Page
Login Controller Operations
POST
Login
Deprecated
POST
Login Oauth
Deprecated