Get the access token.

post https://{tenanturl}/v1.0/endpoint/{opName}/token

Use this API to get the OIDC tokens by using the API client credentials or OIDC application client credentials. For API clients, the returned access tokens can be used to access the APIs that the API client has been granted access to.

Path Params

opName

string

required

Defaults to default

The OpenID Connect provider ID. The default provider ID is "default".

Form Data

code

string

The authorization code. It is only required for "authorization_code" grant types.

code_verifier

string

The code verifier. This optional attribute is for "authorization_code" grant types, when public clients are being used.

redirect_uri

string

The redirect URI. It is only required for "authorization_code" grant types.

username

string

Username credential. Only required for "password" grant type.

password

string

Password credential. Only required for "password" grant type.

device_code

string

Device verification code. Only required for "urn:ietf:params:oauth:grant-type:device_code" grant type.

refresh_token

string

The refresh token. It is only required for "refresh_token" grant types.

client_id

string

The API client's or OIDC application's client ID that is required when the basic authorization header is not set.

client_secret

string

The API client's or OIDC application's client secret that is required when the basic authorization header is not set and the client is not a public client.

assertion

string

Signed and/or encrypted JWT-bearer token. It is only required for "urn:ietf:params:oauth:grant-type:jwt-bearer" grant type.

client_assertion

string

The JWT assertion being used to authenticate the client.

client_assertion_type

string

The format of client assertion. When using client_secret_jwt or private_key_jwt client assertion, the value here must be urn:ietf:params:oauth:client-assertion-type:jwt-bearer.

grant_type

string

required

Defaults to client_credentials

The grant type. The valid grant types for API clients is: client_credentials. The valid grant types for OIDC applications are: authorization_code, refresh_token, password, urn:ietf:params:oauth:grant-type:device_code and urn:ietf:params:oauth:grant-type:jwt-bearer

scope

string

required

Defaults to openid

A space-delimited list of scopes that are associated with this token.

Headers

Authorization

string

The basic authorization header that contains a base64-encoded client ID and the client secret. Use this header as an alternative to sending the client ID and secret in the form parameters.

Responses

404

The resource was not found.

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://tenant_url/v1.0/endpoint/default/token \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --data grant_type=client_credentials \
6
     --data scope=openid

Choose an example:

application/json

200The access token was returned.

400The request was invalid.

500An internal server error occurred.