GetAuthCode-阿里云帮助中心

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

Request parameters

Parameter	Type	Required	Description	Example
ExternalUserId	string	No	The external user ID. This ID is defined by you and must be unique within an Alibaba Cloud account. You must specify either `ExternalUserId` or `EndUserId`.	alice
EndUserId	string	No	The username of the convenience account. The username must be unique within an Alibaba Cloud account. You must specify either `EndUserId` or `ExternalUserId`.	alice
Policy	string	No	An access policy that restricts the permissions granted by the authorization code. If you omit this parameter, the code grants unrestricted access. Syntax: `{ "Version": "1", "Resource": { "Type": "<resource type>", "Id": "<resource ID>" } }` Valid values for <resource type>: `AppInstanceGroup`: An app delivery group. You can obtain the ID of the app delivery group by calling the `ListAppInstanceGroup` operation. `AppInstance`: An application instance. `App`: An application. You can obtain the ID of the application by calling the `ListAppInstanceGroup` operation.	{ "Version": "1", "Resource": { "Type": "AppInstanceGroup", "Id": "aig-9ciijz60n4xsv****" } }
AutoCreateUser	boolean	No	Specifies whether to automatically create a convenience account if no user exists with the specified `ExternalUserId`. This parameter applies only when `EndUserId` is empty. Valid values: true : The convenience account is created. false : The convenience account is not created. This is the default value.	false

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
AuthModel	object	Details about the authorization code.
AuthCode	string	The authorization code. This code is valid for 3 minutes and can be used only once, regardless of verification results. When 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, in UTC and ISO 8601 format.	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.