ListApplications - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves a paginated list of EIAM applications.

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:ListApplications

list

*Application

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20
ApplicationIds	array	No	A list of application IDs.	Ram Account SSO
	string	No	An application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ApplicationName	string	No	The application name. Only left-side fuzzy matching is supported.	Ram Account SSO
AuthorizationType	string	No	The authorization type for application access. Valid values: authorize_required: Access requires explicit authorization. default_all: All members have access by default.	authorize_required
Status	string	No	The application status. Valid values: enabled: Enabled. disabled: Disabled.	enabled
M2MClientStatus	string	No	Specifies whether the Machine-to-Machine (M2M) client identity is enabled.	enabled
ResourceServerStatus	string	No	Specifies whether the resource server feature is enabled.	enabled
SsoType	string	No	The single sign-on (SSO) type to use for filtering.	oauth2/m2m

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries returned.	100
Applications	array<object>	The list of applications.
	object	The application 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
LogoUrl	string	The Uniform Resource Locator (URL) of the application icon.	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
ApplicationName	string	The application name.	SAML 应用
Description	string	The description of the application.	单个应用代码为pkces
SsoType	string	The SSO protocol. Valid values: saml2: Security Assertion Markup Language (SAML) 2.0. oidc: OpenID Connect (OIDC).	saml2
ApplicationSourceType	string	The source from which the application was created. Valid values: urn:alibaba:idaas:app:source:template: The application was created from a template. urn:alibaba:idaas:app:source:standard: The application was created based on a standard protocol.	urn:alibaba:idaas:app:source:standard
Features	string	The features that the application supports. This parameter is returned as a string in a JavaScript Object Notation (JSON) array format. Valid values: sso: Single sign-on. provision: Account synchronization. api_invoke: API invocation.	["sso", "provision"]
Status	string	The application status. Valid values: enabled: Enabled. disabled: Disabled.	enabled
CreateTime	integer	The time when the application was created. This is a UNIX timestamp, in milliseconds.	1649830226000
UpdateTime	integer	The time when the application was last updated. This is a UNIX timestamp, in milliseconds.	1649830226000
ServiceManaged	boolean	Indicates whether the application is managed by an Alibaba Cloud service.	true
ManagedServiceCode	string	The service code of the Alibaba Cloud service that manages the application.	rpa
ApplicationTemplateId	string	The ID of the application template.	apt_xxx_xxx
ApplicationCreationType	string		user_created
ResourceServerStatus	string		enabled
ResourceServerIdentifier	string		test
ResourceServerSourceType	string		urn:cloud:idaas:resourceserver:source:custom

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Applications": [
    {
      "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 应用",
      "Description": "单个应用代码为pkces",
      "SsoType": "saml2",
      "ApplicationSourceType": "urn:alibaba:idaas:app:source:standard",
      "Features": "[\"sso\", \"provision\"]",
      "Status": "enabled",
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000,
      "ServiceManaged": true,
      "ManagedServiceCode": "rpa",
      "ApplicationTemplateId": "apt_xxx_xxx",
      "ApplicationCreationType": "user_created",
      "ResourceServerStatus": "enabled",
      "ResourceServerIdentifier": "test",
      "ResourceServerSourceType": "urn:cloud:idaas:resourceserver:source:custom"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.