All Products
Search
Document Center

Resource Access Management:GetApplication

Last Updated:May 08, 2024

Queries the configuration information about an application.

Operation description

This topic provides an example on how to query the configurations of an application named 472457090344041****.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ram:GetApplicationRead
  • Application
    acs:ram::{#accountId}:application/{#AppName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

472457090344041****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

6616F09B-2768-4C11-8866-A8EE4C4A583E
Applicationobject

The information about the application.

DisplayNamestring

The display name of the application.

myapp
AccessTokenValidityinteger

The validity period of the access token. Unit: seconds.

3600
SecretRequiredboolean

Indicates whether a secret is required.

true
AccountIdstring

The ID of the Alibaba Cloud account to which the application belongs.

177242285274****
CreateDatestring

The creation time.

2020-10-23T08:06:57Z
AppNamestring

The name of the application.

myapp
RedirectUrisarray

The callback URL.

string

The callback URL.

https://www.example.com
UpdateDatestring

The update time.

2020-10-23T08:06:57Z
DelegatedScopeobject

The information about the permissions that are granted on the application.

PredefinedScopesobject []

The information about the permissions that are granted on the application.

Descriptionstring

The description of the permission.

Obtain the OpenID of the user. This is the default permission that you cannot remove.
Namestring

The name of the permission.

openid
Requiredboolean

Indicates whether the permission is automatically selected by default when you install the application. Valid values:

  • true
  • false

openid is required by default.

true
AppIdstring

The ID of the application.

472457090344041****
RefreshTokenValidityinteger

The validity period of the refresh token. Unit: seconds.

7776000
IsMultiTenantboolean

Indicates whether the application can be installed by using other Alibaba Cloud accounts.

true
AppTypestring

The type of the application. 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": "6616F09B-2768-4C11-8866-A8EE4C4A583E",
  "Application": {
    "DisplayName": "myapp",
    "AccessTokenValidity": 3600,
    "SecretRequired": true,
    "AccountId": "177242285274****",
    "CreateDate": "2020-10-23T08:06:57Z",
    "AppName": "myapp",
    "RedirectUris": {
      "RedirectUri": [
        "https://www.example.com"
      ]
    },
    "UpdateDate": "2020-10-23T08:06:57Z",
    "DelegatedScope": {
      "PredefinedScopes": {
        "PredefinedScope": [
          {
            "Description": "Obtain the OpenID of the user. This is the default permission that you cannot remove.",
            "Name": "openid",
            "Required": true
          }
        ]
      }
    },
    "AppId": "472457090344041****",
    "RefreshTokenValidity": 7776000,
    "IsMultiTenant": true,
    "AppType": "WebApp"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-11-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.