Get Access Token By Api Refresh Token Using POST
The end-point is for exchanging organization scoped API-tokens only, that are obtained from the CSP web console.
1. Including the api_token parameter using the application/x-www-form-urlencoded format in the HTTP request body.
2. DEPRECATED: Passing the refresh_token param name, need to use api_token
3. DEPRECATED: Passing the refresh_token via query param
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Anonymous | ✔️ | ✔️ |
The application/x-www-form-urlencoded form data type.
The multi-factor authentication passcode from the registered multi-factor authentication (MFA) device.
The value of the API token.
Deprecated, need to use api_token
List of permissions with resources per service definition, which the access token will be scoped to. Accepts a valid json representation of ServicesPermissionsScopesDto class.
The list of scopes separated by a space and is URL encoded. Scope parameter can be used to request different scopes to obtain a scoped access token
OK
"AccessTokenDto Object"The access token. This is a JWT token that grants access to resources.
The type of the token.
An identifier for the representation of the issued security token.
The ID Token is a signed JWT token returned from the authorization server and contains the user's profile information, including the domain of the identity provider. This domain is used to obtain the identity provider URL. This token is used for optimization so the application can know the identity of the user, without having to make any additional network requests. This token can be generated via the Authorization Code flow only.
The value of the Refresh token.
Access token expiration in seconds.
The scope of access needed for the token
Invalid request body | In case of expired refresh_token.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The requested resource could not be found
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The request could not be processed due to a conflict
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/x-www-form-urlencoded' -d '{}' https://{api_host}/csp/gateway/am/api/auth/api-tokens/authorize