Gets a paginated list of EIAM applications.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eiam:ListApplications |
list |
*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 number of entries per page. |
20 |
| ApplicationIds |
array |
No |
An array of application IDs. |
Ram Account SSO |
|
string |
No |
The application ID. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
|
| ApplicationName |
string |
No |
The application name. This parameter supports only prefix matching. |
Ram Account SSO |
| AuthorizationType |
string |
No |
The authorization type for accessing the application. Valid values:
Valid values:
|
authorize_required |
| Status |
string |
No |
The status of the application. Valid values:
Valid values:
|
enabled |
| M2MClientStatus |
string |
No |
Specifies whether the machine-to-machine (M2M) client identity is enabled for the application. |
enabled |
| ResourceServerStatus |
string |
No |
Specifies whether the resource server capability is enabled for the application. |
enabled |
| SsoType |
string |
No |
The SSO type to filter by. You can specify multiple types by separating them with commas. Example: Valid values:
|
oauth2/m2m |
| ApplicationCreationType |
string |
No |
The creation type of the application. If you leave this parameter empty, user-created applications are queried by default. To query applications of all creation types, set this parameter to Valid values:
|
system_init |
| ApplicationIdentityType |
string |
No |
The identity type of the application. If you leave this parameter empty, identities of the Valid values:
|
application |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| TotalCount |
integer |
The total number of entries. |
100 |
| Applications |
array<object> |
The list of applications. |
|
|
object |
The application details. |
||
| 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 logo URL of the application. |
https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg |
| ApplicationName |
string |
The application name. |
SAML Application |
| Description |
string |
The application description. |
A test application |
| SsoType |
string |
The single sign-on (SSO) protocol. Valid values:
|
saml2 |
| ApplicationSourceType |
string |
The method that was used to create the application. Valid values:
|
urn:alibaba:idaas:app:source:standard |
| Features |
string |
The features that the application supports. The value is a JSON array that is returned as a string. Valid values:
|
["sso", "provision"] |
| Status |
string |
The application status. Valid values:
|
enabled |
| CreateTime |
integer |
The time when the application was created. This value is a UNIX timestamp. Unit: milliseconds. |
1649830226000 |
| UpdateTime |
integer |
The last time when the application was updated. This value is a UNIX timestamp. Unit: milliseconds. |
1649830226000 |
| ServiceManaged |
boolean |
Indicates whether the application is managed by a cloud service. |
true |
| ManagedServiceCode |
string |
The service code of the cloud service that manages the application. |
rpa |
| ApplicationTemplateId |
string |
The application template ID. |
apt_xxx_xxx |
| ApplicationCreationType |
string |
The application creation type. Valid values:
|
user_custom |
| ResourceServerStatus |
string |
The resource server status. |
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 |
| ApplicationIdentityType |
string |
The application identity type. Valid values:
|
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.