GetAuthToken-阿里云帮助中心

Operation description

Preparations

You can register an Alibaba Cloud account, obtain an AccessKey pair, and create an authentication plan before you begin. For more information, see H5 Native Number Verification Integration Flow.

QPS limit

The per-user QPS limit for this operation is 1000 calls per second. Exceeding this limit triggers rate limiting, which may affect your business. Call this operation only as needed.

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

dypns:GetAuthToken

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Url	string	Yes	URL of the request page. Enter the URL you specified when creating the authentication plan in the console. Format: protocol + // + domain name + /. Note For testing, you can temporarily use a public IP address. Use a domain name for production.	https://www.aliyundoc.com/
Origin	string	Yes	Origin URL. Enter the origin URL you specified when creating the authentication plan in the console. Format: protocol + // + domain name.	https://www.aliyundoc.com
SceneCode	string	No	Authentication plan code. Note This parameter is required due to plan upgrades. After creating an authentication plan in the console, pass its code. For details, see Plan Management.	FC10000010643****
BizType	integer	No	Business type. Valid values: 0: Native number verification. 1: One-click logon. Note This parameter is required due to flow optimizations that reduce client-side authentication calls.
CmApiCode	integer	No
CuApiCode	integer	No
CtApiCode	integer	No

Response elements

Element	Type	Description	Example
	object
Code	string	Status code. OK means the request succeeded. For other error codes, see Server-Side API Return Codes.	OK
Message	string	Description of the status code.	请求成功
RequestId	string	Request ID.	8906582E-6722
TokenInfo	object	Struct.
AccessToken	string	Business authentication token. Note An AccessToken is valid for 10 minutes. You can reuse it during this period.	agag****
JwtToken	string	API authentication token. Note A JwtToken is valid for 1 hour. You can reuse it during this period.	aweghd****

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "8906582E-6722",
  "TokenInfo": {
    "AccessToken": "agag****",
    "JwtToken": "aweghd****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.