ObtainApplicationClientSecret - Identity as a Service - Alibaba Cloud Documentation Center

Queries a client key of an Employee Identity and Access Management (EIAM) application. The returned key secret is masked. If you want to query the key secret that is not masked, call the ListApplicationClientSecrets operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eiam:ObtainApplicationClientSecret		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	Yes	The ID of the application whose client key you want to query.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
SecretId	string	Yes	The client key ID of the application.	sci_k52x2ru63rlkflina5utgkxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationClientSecret	object	The information about the client key.
InstanceId	string	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	The ID of the application whose client key you want to query.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ClientId	string	The client ID of the application.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
SecretId	string	The client key ID of the application.	sci_k52x2ru63rlkflina5utgkxxxx
ClientSecret	string	The client key secret of the application.	CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx
Status	string	The status of the client key. Valid values: Enabled: The client key is enabled. Disabled: The client key is disabled.	enabled
LastUsedTime	long	The time when the client key was last used. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000

Examples

Sample success responses

JSONformat

{
  "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
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history