All Products
Search

This Product

    Identity as a Service:GetApplication

    Document Center

    Identity as a Service:GetApplication

    Last Updated:Aug 04, 2025

    Retrieves the details of a specified EIAM application.

    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 support 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:GetApplication

    get

    *Application

    acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    ApplicationId

    string

    Yes

    The application ID.

    app_mkv7rgt4d7i4u7zqtzev2mxxxx

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    Application

    object

    The information about the application.

    ApiInvokeStatus

    string

    The status of the Developer API feature for the application. Valid values:

    • enabled: The feature is enabled.

    • disabled: The feature is disabled.

    disabled
    ApplicationVisibility

    array

    The visibility of the application.

    string

    The visibility of the application.

    [web]
    ApplicationId

    string

    The application ID.

    app_mkv7rgt4d7i4u7zqtzev2mxxxx
    ApplicationName

    string

    The application name.

    SAML Application

    ApplicationSourceType

    string

    The source from which the application was created. Valid values:

    • urn:alibaba:idaas:app:source:template: The application was created from a template.

    • urn:alibaba:idaas:app:source:standard: The application was created based on a standard protocol.

    urn:alibaba:idaas:app:source:template
    ApplicationTemplateId

    string

    The ID of the application template that was used to create the application. This parameter is returned only when the application is created from a template.

    apt_rpa_tdsxxx
    AuthorizationType

    string

    The authorization type for access to the application. Valid values:

    • authorize_required: Access is allowed only after explicit authorization.

    • default_all: Access is allowed for all members by default.

    authorize_required
    ClientId

    string

    The client ID of the application.

    app_mkv7rgt4d7i4u7zqtzev2mxxxx
    CreateTime

    integer

    The time when the application was created. This value is a UNIX timestamp. Unit: milliseconds.

    1649830226000
    Description

    string

    The description of the application.

    The application is applicable to the test environment.

    Features

    string

    The features that the application supports. This parameter is returned as a JSON array string. Valid values:

    • sso: single sign-on.

    • provision: account synchronization.

    • api_invoke: API access.

    ["sso", "provision"]
    InstanceId

    string

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    LogoUrl

    string

    The URL of the application icon.

    https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg
    ManagedServiceCode

    string

    The service code of the cloud service that hosts the application template.

    rpa
    ServiceManaged

    boolean

    Indicates whether the application template is hosted by a cloud service.

    true
    SsoType

    string

    The single sign-on (SSO) protocol. Valid values:

    • saml2: SAML 2.0.

    • oidc: OpenID Connect.

    saml2
    Status

    string

    The application status. Valid values:

    • enabled: The application is enabled.

    • disabled: The application is disabled.

    enabled
    UpdateTime

    integer

    The time when the application was last updated. This value is a UNIX timestamp. Unit: milliseconds.

    1649830226000
    M2MClientStatus

    string

    The status of the M2M client.

    enabled
    ResourceServerStatus

    string

    The status of the resource server.

    disabled enabled
    ResourceServerIdentifier

    string

    The unique identifier of the resource server. This corresponds to the audience of the resource server.

    https://www.example.com
    CustomSubjectStatus

    string

    Indicates whether to customize the Subject field in the token. If this feature is enabled, the subject of the issued access token changes from to :<client.activeSubjectUrn>. The client.activeSubjectUrn is set in the attribute mapping of the application's federated identity provider.

    enabled

    Examples

    Success response

    JSON format

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Application": {
    "ApiInvokeStatus": "disabled",
    "ApplicationVisibility": [
      "[web]"
    ],
    "ApplicationId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "ApplicationName": "SAML Application\n",
    "ApplicationSourceType": "urn:alibaba:idaas:app:source:template",
    "ApplicationTemplateId": "apt_rpa_tdsxxx",
    "AuthorizationType": "authorize_required",
    "ClientId": "app_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "CreateTime": 1649830226000,
    "Description": "The application is applicable to the test environment.\n",
    "Features": "[\"sso\", \"provision\"]",
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "LogoUrl": "https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg",
    "ManagedServiceCode": "rpa",
    "ServiceManaged": true,
    "SsoType": "saml2",
    "Status": "enabled",
    "UpdateTime": 1649830226000,
    "M2MClientStatus": "enabled",
    "ResourceServerStatus": "disabled\tenabled",
    "ResourceServerIdentifier": "https://www.example.com",
    "CustomSubjectStatus": "enabled"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.