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
|
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
|
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
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
|
request_id |
String |
Unique ID of a request. |
Status code: 403
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot