ListApplications - Identity as a Service - Alibaba Cloud Documentation Center

Performs a paged query to retrieve one or more EIAM application records.

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	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	No	Page number.	1
PageSize	integer	No	The number of entries per page.	20
ApplicationIds	array	No	List of application IDs.	Ram Account SSO
	string	No	Application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ApplicationName	string	No	Application name. Supports left-side fuzzy match only.	Ram Account SSO
AuthorizationType	string	No	Application access authorization type. Valid values: authorize_required: Explicit authorization required for access. default_all: All members have access by default. Valid values: authorize_required : Explicit authorization required for access default_all : All members have access by default	authorize_required
Status	string	No	Application status. Valid values: enabled: Enabled. disabled: Disabled. Valid values: disabled : Disabled enabled : Enabled	enabled
M2MClientStatus	string	No	Indicates whether M2M Client identity is enabled.	enabled
ResourceServerStatus	string	No	Indicates whether ResourceServer capability is enabled.	enabled
SsoType	string	No	SSO type filter. To specify multiple types, separate them with commas (example: oauth2/m2m,oidc+oauth2/m2m). Valid values: oauth2/m2m : oauth2/m2m saml2 : saml2 oidc : oidc oidc+oauth2/m2m : oidc+oauth2/m2m	oauth2/m2m
ApplicationCreationType	string	No	Application creation type. If empty, defaults to user_custom. To query all types, use: all. Valid values: system_init : System-created user_custom : User-created	system_init
ApplicationIdentityType	string	No		application

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	Total number of entries.	100
Applications	array<object>	List of application information.
	object	Application information.
InstanceId	string	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
ApplicationId	string	Application ID.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
ClientId	string	Client ID of the application.	app_mkv7rgt4d7i4u7zqtzev2mxxxx
LogoUrl	string	URL of the application logo.	https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
ApplicationName	string	Application name.	SAML 应用
Description	string	Application description.	单个应用代码为pkces
SsoType	string	Single sign-on protocol. Valid values: saml2: SAML 2.0 protocol. oidc: OpenID Connect protocol. oauth2/m2m: OAuth 2.0 protocol. oidc+oauth2/m2m: OpenID Connect and OAuth 2.0 protocols.	saml2
ApplicationSourceType	string	Application source type. Valid values: urn:alibaba:idaas:app:source:template: Application template. urn:alibaba:idaas:app:source:standard: Standard protocol.	urn:alibaba:idaas:app:source:standard
Features	string	Supported features of the application, returned as a JSON array string. Valid values: sso: Single sign-on. slo: Single logout. provision: Account synchronization. api_invoke: API exposure. m2m_client: M2M Client capability. resource_server: API service capability. other: Fallback.	["sso", "provision"]
Status	string	Application status. Valid values: enabled: Enabled. disabled: Disabled. deleted: Soft deleted	enabled
CreateTime	integer	Application creation time, in Unix timestamp format (milliseconds).	1649830226000
UpdateTime	integer	Most recent application update time, in Unix timestamp format (milliseconds).	1649830226000
ServiceManaged	boolean	Indicates whether the application template is managed by a cloud service.	true
ManagedServiceCode	string	ServiceCode of the cloud service that manages the application template.	rpa
ApplicationTemplateId	string	Application template ID.	apt_xxx_xxx
ApplicationCreationType	string	Application creation type. Valid values: system_init : System-created user_custom : User-created	user_custom
ResourceServerStatus	string	Resource server status.	enabled
ResourceServerIdentifier	string	Unique identifier of the ResourceServer.	https://example.com
ResourceServerSourceType	string	Resource server source type. Valid values: urn:cloud:idaas:resourceserver:source:custom : Custom urn:cloud:idaas:resourceserver:source:system : System	urn:cloud:idaas:resourceserver:source:custom
ApplicationIdentityType	string

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_custom",
      "ResourceServerStatus": "enabled",
      "ResourceServerIdentifier": "https://example.com",
      "ResourceServerSourceType": "urn:cloud:idaas:resourceserver:source:custom",
      "ApplicationIdentityType": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.