DocsICP FilingConsole
Documentation

ListApplications

Updated at:
Copy as MD
Product
My Favorites

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 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 page size.

20
ApplicationIds

array

No

A list of application IDs.

Ram Account SSO

string

No

The application ID.

app_mkv7rgt4d7i4u7zqtzev2mxxxx
ApplicationName

string

No

The application name. Only prefix 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.

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.

Valid values:

  • disabled :

    Disabled

  • enabled :

    Enabled

enabled
M2MClientStatus

string

No

The status of the M2M client identity.

enabled
ResourceServerStatus

string

No

The status of the resource server capability.

enabled
SsoType

string

No

A filter for the Single Sign-On (SSO) type. You can specify multiple types, separated by a comma. 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

The application creation type. If unspecified, only user-created (user_custom) applications are returned. To query applications of all types, set this parameter to all.

Valid values:

  • system_init :

    System-created

  • user_custom :

    User-created

system_init
ApplicationIdentityType

string

No

The application identity type. If unspecified, only applications of the application type are returned. To query all identity types, set this parameter to all.

Valid values:

  • all :

    all

  • agent :

    Agent

  • application :

    Application

application
CustomFields

array<object>

No

A list of custom fields.

object

No

A custom field object.

FieldName

string

No

The custom field identifier. Valid values:

  • agent_type: The agent type.

agent_type
FieldValue

string

No

The custom field value.

x-claw

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 details of an application.

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 URL of the application logo.

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.

A test application
SsoType

string

The SSO protocol. Valid values:

  • saml2: SAML 2.0

  • oidc: OpenID Connect (OIDC)

  • oauth2/m2m: OAuth 2.0

  • oidc+oauth2/m2m: OIDC and OAuth 2.0

saml2
ApplicationSourceType

string

The source used to create the application. 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

A string containing a JSON array of features supported by the application. Valid values:

  • sso: SSO.

  • slo: SLO.

  • provision: Provisioning.

  • api_invoke: API invocation.

  • m2m_client: M2M client.

  • resource_server: Resource server.

  • other: Other.

["sso", "provision"]
Status

string

The status of the application. Valid values:

  • enabled: The application is enabled.

  • disabled: The application is disabled.

  • deleted: The application is soft-deleted.

enabled
CreateTime

integer

The time the application was created, as a Unix timestamp in milliseconds.

1649830226000
UpdateTime

integer

The time the application was last updated, as a Unix timestamp in milliseconds.

1649830226000
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 application template.

apt_xxx_xxx
ApplicationCreationType

string

Indicates how the application was created.

Valid values:

  • system_init :

    Created by the system.

  • user_custom :

    Created by a user.

user_custom
ResourceServerStatus

string

The status of the resource server.

enabled
ResourceServerIdentifier

string

The unique identifier of the resource server.

https://example.com
ResourceServerSourceType

string

The source type of the resource server.

Valid values:

  • urn:cloud:idaas:resourceserver:source:custom :

    Custom

  • urn:cloud:idaas:resourceserver:source:system :

    System

urn:cloud:idaas:resourceserver:source:custom
ApplicationIdentityType

string

The identity type of the application.

Valid values:

  • agent :

    Agent

  • application :

    Application

application

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 Application",
      "Description": "A test application",
      "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": "application"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.