ObtainApplicationClientSecret - Identity as a Service - Alibaba Cloud Documentation Center

Obtains the client secret for an EIAM application. The secret is returned without desensitization. To obtain a desensitized secret, call the ListApplicationClientSecrets 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 support 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:ObtainApplicationClientSecret

get

*Secret

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	eiam-111ccc1111
ApplicationId	string	Yes	The application ID.	app_11111
SecretId	string	Yes	The client secret ID of the application.	sct_11111

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationClientSecret	object	The secret information.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	The application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ClientId	string	The client ID of the application.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
SecretId	string	The client secret ID of the application.	sci_k52x2ru63rlkflina5utgkxxxx
ClientSecret	string	The client secret of the application.	CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx
Status	string	The status of the client secret. Valid values: enabled: The secret is enabled. disabled: The secret is disabled.	enabled
LastUsedTime	integer	The last time the client secret was used. This is a UNIX timestamp. Unit: milliseconds.	1649830226000
ExpirationTime	integer	The expiration time of the client secret. This is a UNIX timestamp. Unit: milliseconds.	1749830226000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationClientSecret": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "ClientId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "SecretId": " sci_k52x2ru63rlkflina5utgkxxxx",
    "ClientSecret": "CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx",
    "Status": "enabled",
    "LastUsedTime": 1649830226000,
    "ExpirationTime": 1749830226000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.