ListExternalApplications API Reference & Parameters - Resource Access Management - Alibaba Cloud - Resource Access Management

Queries information about all installed external 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

ram:ListExternalApplications

list

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	936E1D9C-157D-45BD-8A3B-81C0716EB077
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true
Marker	string	A pagination token. It can be used in the next request to retrieve a new page of results. Note This parameter is returned only when `IsTruncated` is `true`.	EXAMPLE
ExternalApplications	object
ExternalApplication	array<object>	The information about the external applications.
	array<object>
DisplayName	string	The display name of the external application.	GiteeAliyun
UpdateDate	string	The update time of the external application. The value is a timestamp.	1603693518000
DelegatedScope	object	The information about the permissions that are granted to the external application.
PredefinedScopes	object
PredefinedScope	array<object>	The information about the permissions that are granted to the external application.
	object
Description	string	The description of the permission.	Used to obtain user OpenID (default scope, not removable)
Name	string	The name of the permission.	openid
AppPrincipalName	string	The name of the external application principal. The value is in the `<app_name>@app.<account_id>.onaliyun.com` format.	GiteePrd@app.153082740420****.onaliyun.com
CreateDate	string	The time when the external application was installed. The value is a timestamp.	1603693318000
TenantId	string	The ID of the Alibaba Cloud account for which the external application was installed.	173082740420****
ForeignAppId	string	The ID of the external application.	407426893752729****

Examples

Success response

JSON format

{
  "RequestId": "936E1D9C-157D-45BD-8A3B-81C0716EB077",
  "IsTruncated": true,
  "Marker": "EXAMPLE",
  "ExternalApplications": {
    "ExternalApplication": [
      {
        "DisplayName": "GiteeAliyun",
        "UpdateDate": "1603693518000",
        "DelegatedScope": {
          "PredefinedScopes": {
            "PredefinedScope": [
              {
                "Description": "Used to obtain user OpenID (default scope, not removable)",
                "Name": "openid"
              }
            ]
          }
        },
        "AppPrincipalName": "GiteePrd@app.153082740420****.onaliyun.com",
        "CreateDate": "1603693318000",
        "TenantId": "173082740420****",
        "ForeignAppId": "407426893752729****"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.