GetApplication - Identity as a Service - Alibaba Cloud Documentation Center

Queries the details of an Employee Identity and Access Management (EIAM) application.

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:GetApplication	get	*Application `acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}`	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 that you want to query.	app_mkv7rgt4d7i4u7zqtzev2mxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Application	object	The details of the application.
InstanceId	string	The ID of the instance.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	The ID of the application.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ClientId	string	The client ID of the application.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
LogoUrl	string	The URL of the application icon.	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
ApplicationName	string	The name of the application.	SAML Application
Description	string	The description of the application.	The application is applicable to the test environment.
ApplicationSourceType	string	The origin of the application. Valid values: urn:alibaba:idaas:app:source:template: The application is created based on a template. urn:alibaba:idaas: The application is created based on the standard protocol.	urn:alibaba:idaas:app:source:template
SsoType	string	The type of the single sign-on (SSO) protocol. Valid values: saml2: the Security Assertion Markup Language (SAML) 2.0 protocol. oidc: the OpenID Connect (OIDC) protocol.	saml2
Features	string	The features that are supported by the application. The value is a JSON array. Valid values: sso: The application supports SSO. provision: The application supports account synchronization. api_invoke: The application supports custom APIs.	["sso", "provision"]
Status	string	The status of the application. Valid values: Enabled: The application is enabled. Disabled: The application is disabled.	enabled
CreateTime	long	The time when the application was created. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
UpdateTime	long	The time when the application was last updated. The value is a UNIX timestamp. Unit: milliseconds.	1649830226000
AuthorizationType	string	The authorization type of the EIAM application. Valid values: authorize_required: Only the user with explicit authorization can access the application. default_all: By default, all users can access the application.	authorize_required
ApiInvokeStatus	string	The status of the Developer API feature. Valid values: Enabled: The Developer API feature is enabled. Disabled: The Developer API feature is disabled.	disabled
ServiceManaged	boolean	Indicates whether the application template is managed by a cloud service.	true
ManagedServiceCode	string	The service code of the cloud service that manages the application template.	rpa
ApplicationTemplateId	string	The ID of the template based on which the application is created. This parameter is returned only if the application is created based on a template.	apt_rpa_tdsxxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Application": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "ClientId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg",
    "ApplicationName": "SAML Application\n",
    "Description": "The application is applicable to the test environment.\n",
    "ApplicationSourceType": "urn:alibaba:idaas:app:source:template",
    "SsoType": "saml2",
    "Features": "[\"sso\", \"provision\"]",
    "Status": "enabled",
    "CreateTime": 1649830226000,
    "UpdateTime": 1649830226000,
    "AuthorizationType": "authorize_required",
    "ApiInvokeStatus": "disabled",
    "ServiceManaged": true,
    "ManagedServiceCode": "rpa",
    "ApplicationTemplateId": "apt_rpa_tdsxxx"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-11-16	The response structure of the API has changed	View Change Details