ListApplications - Resource Access Management - Alibaba Cloud Documentation Center

Lists the created applications.

Operation description

This topic provides an example on how to query the applications within the current account. The returned result shows that only one application named myapp belongs to the current account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
ram:ListApplications	List	Application acs:ram::{#accountId}:application/*	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	CE458B58-8C40-46F7-A9D4-CB85136B0C06
Applications	object []	The information about the application.
DisplayName	string	The display name of the application.	myapp
AccessTokenValidity	integer	The validity period of the access token. Unit: seconds.	3600
SecretRequired	boolean	Indicates whether a secret is required.	true
AccountId	string	The ID of the Alibaba Cloud account to which the application belongs.	177242285274****
CreateDate	string	The creation time.	2020-10-23T09:33:22Z
AppName	string	The application name.	myapp
RedirectUris	array	The callback URLs.
	string	The callback URL.	https://www.example.com
UpdateDate	string	The update time.	2020-10-23T09:33:22Z
DelegatedScope	object	The information about the permissions that are granted on the application.
PredefinedScopes	object []	The information about the permissions that are granted on the application.
Description	string	The description of the permission.	Obtain the OpenID of the user. This is the default permission that you cannot remove.
Name	string	The name of the permission.	openid
Required	boolean	Indicates whether the permission is automatically selected by default when you install the application. Valid values: true false `openid` is required by default.	true
AppId	string	The ID of the application.	441442900344560****
RefreshTokenValidity	integer	The validity period of the refresh token. Unit: seconds.	7776000
IsMultiTenant	boolean	Indicates whether the application can be installed by using other Alibaba Cloud accounts.	true
AppType	string	The application type. Valid values: WebApp: a web application. NativeApp: a native application that runs on an operating system, such as a desktop or mobile operating system. ServerApp: an application that can access Alibaba Cloud services without the need for user logon. Only applications that synchronize user information based on the System for Cross-domain Identity Management (SCIM) protocol are supported.	WebApp

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE458B58-8C40-46F7-A9D4-CB85136B0C06",
  "Applications": {
    "Application": [
      {
        "DisplayName": "myapp",
        "AccessTokenValidity": 3600,
        "SecretRequired": true,
        "AccountId": "177242285274****",
        "CreateDate": "2020-10-23T09:33:22Z",
        "AppName": "myapp",
        "RedirectUris": {
          "RedirectUri": [
            "https://www.example.com"
          ]
        },
        "UpdateDate": "2020-10-23T09:33:22Z",
        "DelegatedScope": {
          "PredefinedScopes": {
            "PredefinedScope": [
              {
                "Description": "Obtain the OpenID of the user. This is the default permission that you cannot remove.",
                "Name": "openid",
                "Required": true
              }
            ]
          }
        },
        "AppId": "441442900344560****",
        "RefreshTokenValidity": 7776000,
        "IsMultiTenant": true,
        "AppType": "WebApp"
      }
    ]
  }
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-11-23

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.