Listing Access Tokens
Function
This API is used to list access tokens. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
GET /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: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
bearer_tokens |
Array of BearerToken objects |
Access token list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
creation_time |
Number |
Creation time. |
|
expiration_time |
Number |
Expiration time. |
|
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
Listing access tokens
GET https://{hostname}/v1/identity-stores/{identity_store_id}/tenant/{tenant_id}/bearer-token
Example Response
Status code: 200
Successful
{
"bearer_tokens" : [ {
"creation_time" : 1754277891140,
"expiration_time" : 1785813891000,
"token_id" : "5bd76fe3-48cc-4e4b-a235-a4e6xxxx"
}, {
"creation_time" : 1754278569276,
"expiration_time" : 1785814569000,
"token_id" : "715ad873-3b32-48a3-a08f-50fxxxxxx7"
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
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.