GetApplicationTemplate - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves the details of an application template.

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

eiam:GetApplicationTemplate

get

*ApplicationTemplate

acs:eiam:{#regionId}:{#accountId}:applicationtemplate/{#ApplicationTemplateId}

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationTemplateId	string	Yes	The ID of the application template.	apt_ramuser_xxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ApplicationTemplate	object	The details of the application template.
ApplicationTemplateId	string	The ID of the application template.	apt_ramintlrole_ixxxxx
ApplicationTemplateName	string	The name of the application template.	Alibaba Cloud
Description	string	The description of the application template.	Alibaba Cloud SSO
LogoUrl	string	The URL of the logo for the application template.	https://example.com/imgextra/i4/O1CN01xTLxLb1WtyKksHW1H_!!6000000002847-2-tps-xxx-xxx.png
HelpDocumentUrl	string	The URL of the help document for the application template.	https://example.com/document_detail/409xxx.html
CreateTime	integer	The time when the application template was created.	1730341123000
UpdateTime	integer	The time when the application template was last updated.	1730341124000
SaleInfo	object	The sales information about the application template.
AlwaysFree	boolean	Indicates whether the application template is permanently free.	true
ServiceManaged	boolean	Indicates whether the application template is managed by an Alibaba Cloud service.	true
ManagedServiceCode	string	The service code of the Alibaba Cloud service that manages the application template.	bastionhost
ServiceConsoleUrl	string	The URL of the console for the Alibaba Cloud service that manages the application template.	https://example.com/?p=bastion
SsoTypes	array	The supported Single Sign-On (SSO) protocols.
	string	The SSO protocol type. Valid values: saml2 : saml2 oidc : oidc	saml2

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ApplicationTemplate": {
    "ApplicationTemplateId": "apt_ramintlrole_ixxxxx",
    "ApplicationTemplateName": "Alibaba Cloud ",
    "Description": "Alibaba Cloud SSO",
    "LogoUrl": "https://example.com/imgextra/i4/O1CN01xTLxLb1WtyKksHW1H_!!6000000002847-2-tps-xxx-xxx.png",
    "HelpDocumentUrl": "https://example.com/document_detail/409xxx.html",
    "CreateTime": 1730341123000,
    "UpdateTime": 1730341124000,
    "SaleInfo": {
      "AlwaysFree": true
    },
    "ServiceManaged": true,
    "ManagedServiceCode": "bastionhost",
    "ServiceConsoleUrl": "https://example.com/?p=bastion",
    "SsoTypes": [
      "saml2"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.