All Products
Search

This Product

    App Streaming:GetAuthCode

    Document Center

    App Streaming:GetAuthCode

    Last Updated:Dec 10, 2025

    Gets an authorization code that contains user identity and permission information. You can use this code to start a cloud application in an integration use case.

    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

    ecd:GetAuthCode

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ExternalUserId

    string

    No

    The external user ID. The caller defines this ID. The ID must be unique within an Alibaba Cloud account. This parameter and EndUserId cannot both be empty.

    alice

    EndUserId

    string

    No

    The username of the convenience account. The username must be unique within an Alibaba Cloud account. This parameter and ExternalUserId cannot both be empty.

    alice

    Policy

    string

    No

    The access policy that restricts the access permissions of the authorization code. If this parameter is empty, no limitations are imposed.

    Syntax:

    {
      "Version": "1",
      "Resource": {
            "Type": "<resource_type>",
            "Id": "<resource_ID>"
      }
}

    The valid values for <resource_type> are:

    • AppInstanceGroup: the app delivery group. Get the ID by calling the ListAppInstanceGroup operation.

    • AppInstance: the application instance. This is a dedicated field.

    • App: the application. Get the ID by calling the ListAppInstanceGroup operation.

    { "Version": "1", "Resource": { "Type": "AppInstanceGroup", "Id": "aig-9ciijz60n4xsv****" } }

    AutoCreateUser

    boolean

    No

    Specifies whether to create a new EndUserId based on the ExternalUserId. This parameter takes effect only when EndUserId is empty.

    false

    Response elements

    Parameter

    Type

    Description

    Example

    object

    The response elements.

    RequestId

    string

    The request ID.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****

    AuthModel

    object

    The information about the authorization code.

    AuthCode

    string

    The authorization code. It is valid for 3 minutes and can be used only once, regardless of verification results. If multiple codes are generated for a user, only the most recent one is valid.

    acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********

    EndUserId

    string

    The username of the convenience account.

    alice

    ExpireTime

    string

    The expiration time of the authorization code. The time is in Coordinated Universal Time (UTC) and follows the ISO 8601 standard.

    2015-01-23T12:33:18Z

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "AuthModel": {
    "AuthCode": "acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********",
    "EndUserId": "alice",
    "ExpireTime": "2015-01-23T12:33:18Z"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.