GetApplicationProvisionInfo API Reference - RAM - Alibaba Cloud - Resource Access Management

Queries the installation information of a specified installed application.

Operation description

Before you call this operation, the target application must be installed. You can call ProvisionApplication to install the application and use the AppId of the installed application. Calling this operation with an application ID returned by CreateApplication for an application that has not been installed will fail.

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:GetApplicationProvisionInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application. You can call ListApplicationProvisionInfos to obtain the AppId of an installed application.	452392483381546****

Response elements

Element	Type	Description	Example
	object
ApplicationProvisionInfo	object	The application installation information.
AccountId	string	The Alibaba Cloud account ID.	177242285274****
AppCategory	string	The application category. Valid values: Official: official applications ThirdParty: regular third-party applications	ThirdParty
AppId	string	The ID of the application.	452392483381546****
AppName	string	The name of the application.	GiteePrd
AssignmentType	string	The application assignment type. Valid values: AllowAll: No assignment is required. All RAM users and roles can access the application. OnDemand: Assignment is required on demand. RAM users and roles can access the application only after it is assigned to them.	AllowAll
CreateDate	string	The installation timestamp.	1603693518000
DelegatedScope	object	The application permission scope information.
PredefinedScopes	object
PredefinedScope	array<object>	The application permission scope information.
	object
Description	string	The scope description.	Used to obtain the OpenID of the user (default permission scope, cannot be removed)
Name	string	The name of the scope.	openid
DisplayName	string	The display name of the application.	GiteeAliyun
NeedPrincipalConsent	boolean	Indicates whether user authorization is required.	true
UpdateDate	string	The update timestamp.	1603693518000
RequestId	string	The request ID.	936E1D9C-157D-45BD-8A3B-81C0716EB078

Examples

Success response

JSON format

{
  "ApplicationProvisionInfo": {
    "AccountId": "177242285274****",
    "AppCategory": "ThirdParty",
    "AppId": "452392483381546****",
    "AppName": "GiteePrd",
    "AssignmentType": "AllowAll",
    "CreateDate": "1603693518000",
    "DelegatedScope": {
      "PredefinedScopes": {
        "PredefinedScope": [
          {
            "Description": "Used to obtain the OpenID of the user (default permission scope, cannot be removed)",
            "Name": "openid"
          }
        ]
      }
    },
    "DisplayName": "GiteeAliyun",
    "NeedPrincipalConsent": true,
    "UpdateDate": "1603693518000"
  },
  "RequestId": "936E1D9C-157D-45BD-8A3B-81C0716EB078"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.