Updated on 2025-08-21 GMT+08:00

Creating an Access Token

Function

This API is used to create an access token. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/identity-stores/{identity_store_id}/tenant/{tenant_id}/bearer-token

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

tenant_id

Yes

String

Globally unique ID of an automatic provisioning.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 201

Table 3 Parameters in the response body

Parameter

Type

Description

creation_time

Number

Creation time.

expiration_time

Number

Expiration time.

token

String

Access token.

token_id

String

Globally unique ID of an access token.

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Example Request

Creating an access token

POST https://{hostname}/v1/identity-stores/{identity_store_id}/tenant/{tenant_id}/bearer-token

Example Response

Status code: 201

Successful

{
  "creation_time" : 1754278569275,
  "expiration_time" : 1785814569000,
  "token" : "eyJraWQiOiJmZUV4U0oxRV***************83yzVQVY",
  "token_id" : "715ad873-3b32-48a3-a08f-50xxxxx"
}

Status Codes

Status Code

Description

201

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.