ListAuthenticationTokens - Identity as a Service - Alibaba Cloud Documentation Center

Lists authentication tokens.

Operation description

This API uses an Access Token issued by IDaaS for identity authentication and authorization.

Ensure that the Access Token you provide has the Query authentication tokens permission for the built-in Privileged Access Management (PAM) application in IDaaS.

Note

The required scope is urn:cloud:idaas:pam|authentication_token:read.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /v2/{instanceId}/authenticationTokens HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx

Request parameters

Parameter	Type	Required	Description	Example
Authorization	string	Yes	Authentication information. Format: Bearer ${access_token}. Note Enter an IDaaS-issued Access Token.	Bearer xxxxxx
nextToken	string	No	Token that marks the start of the next page in a paged query.	NTxxxxxexample
maxResults	integer	No	Maximum number of records to return in this paged query.	20
consumerId	string	Yes	ID of the authentication token consumer.	app_ngtkgrrxxxxktg5eao6z4xxxxx
credentialProviderIdentifier	string	Yes	Credential provider identifier.	test_example_identifier
revoked	boolean	No	Indicates whether the authentication token is revoked.	false
expired	boolean	No	Indicates whether the authentication token is expired.	false

Response elements

Element	Type	Description	Example
	object	Paged query result.
entities	array<object>	List of resource entities.
	object	Authentication token details.
instanceId	string	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
authenticationTokenId	string	Authentication token ID.	atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx
credentialProviderId	string	Credential provider ID.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
createTime	integer	Creation time of the authentication token, as a UNIX timestamp in milliseconds.	1649830225000
updateTime	integer	Last update time of the authentication token, as a UNIX timestamp in milliseconds.	1649830225000
authenticationTokenType	string	Authentication token type. Valid values: jwt: JWT authentication token oauth_access_token: OAuth Access Token authentication token	jwt
revoked	boolean	Indicates whether the authentication token is revoked.	false
creatorType	string	Type of the authentication token creator. Valid values: application: Application	application
creatorId	string	ID of the authentication token creator.	app_ngtkgrrxxxxktg5eao6z4xxxxx
consumerType	string	Type of the authentication token consumer. Valid values: application: Application custom: Custom type	custom
consumerId	string	ID of the authentication token consumer.	test_jwt_subject
expirationTime	integer	Expiration time of the authentication token, as a UNIX timestamp in milliseconds.	1772693568000
totalCount	integer	Total number of resource entities that match the query criteria.	100
nextToken	string	Token returned by this call. Use it for the next paged query to get the next page.	NTxxxexample
maxResults	integer	Maximum number of records returned in this query.	20

Examples

Success response

JSON format

{
  "entities": [
    {
      "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
      "credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
      "createTime": 1649830225000,
      "updateTime": 1649830225000,
      "authenticationTokenType": "jwt",
      "revoked": false,
      "creatorType": "application",
      "creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
      "consumerType": "custom",
      "consumerId": "test_jwt_subject",
      "expirationTime": 1772693568000
    }
  ],
  "totalCount": 100,
  "nextToken": "NTxxxexample",
  "maxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.