[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Access Token By API Refresh Token

Description

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 ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/auth/api-tokens/authorize
Copy

Request Body

Request Body

GetAccessTokenByApiRefreshTokenRequest of mimetype application/x-www-form-urlencoded Optional

The application/x-www-form-urlencoded form data type.

{
	"api_token": "string",
	"passcode": "string",
	"refresh_token": "string"
}
string
api_token Optional

The value of the API token.


string
passcode Optional

The multi-factor authentication passcode from the registered multi-factor authentication (MFA) device.


string
refresh_token Optional

Deprecated, need to use api_token

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns AccessTokenDto of type application/json
{
	"access_token": "string",
	"expires_in": 0,
	"id_token": "string",
	"refresh_token": "string",
	"scope": "string",
	"token_type": "string"
}
string
access_token Optional

The access token. This is a JWT token that grants access to resources.


integer as int64
expires_in Optional

Access token expiration in seconds.


string
id_token Optional

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.


string
refresh_token Optional

The value of the Refresh token.


string
scope Optional

The scope of access needed for the token


string
token_type Optional

The type of the token.

Errors

Errors

400

Invalid request body | In case of expired refresh_token.


404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d '{"api_token":"string","passcode":"string","refresh_token":"string"}' https://{api_host}/csp/gateway/am/api/auth/api-tokens/authorize
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: ""
x-slo-tier: TIER1


Feedback

Was this page helpful?