Call ObtainApplicationToken API for Secure SSO Integration - EIAM

Queries the token of a specified application.

Operation description

When you disable an application, all its features, such as single sign-on (SSO) and account synchronization, become unavailable. Ensure that you understand the potential threats of this operation.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eiam:ObtainApplicationToken

get

*ApplicationToken

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	Yes	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ApplicationTokenId	string	Yes	The application token ID.	token_sfrwerxxxxxxxxxxxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationToken	object	The application token.
InstanceId	string	The ID of the IDaaS EIAM instance.	idaas_ki6hd7ihir4ybawogqk6kqxxxx
ApplicationId	string	The application ID.	app_na2r73a65s7o4zbs7nj5gxxxx
ApplicationTokenId	string	The application token ID.	token_m7aso6v4efvu2otfq3jdzxxxx
ApplicationTokenType	string	The type of the application token.	bearer_token
ApplicationToken	string	The application token.	SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBxxxxx
Status	string	The status.	enabled
ExpirationTime	integer	The expiration time.	1735610950000
LastUsedTime	integer	The time when the token was last used.	1735610930000
CreateTime	integer	The time when the application token was created.	1735610930000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationToken": {
    "InstanceId": "idaas_ki6hd7ihir4ybawogqk6kqxxxx",
    "ApplicationId": "app_na2r73a65s7o4zbs7nj5gxxxx",
    "ApplicationTokenId": "token_m7aso6v4efvu2otfq3jdzxxxx",
    "ApplicationTokenType": "bearer_token",
    "ApplicationToken": "SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBxxxxx",
    "Status": "enabled",
    "ExpirationTime": 1735610950000,
    "LastUsedTime": 1735610930000,
    "CreateTime": 1735610930000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.