DocsICP FilingConsole
官方文档
首页

CreateVerifyScheme

更新时间：
复制 MD 格式
产品详情
我的收藏

A verification scheme identifies authentication scenarios for an application (App). Each scheme typically corresponds to an App name, App package name, and package signature. The required parameters vary depending on the access terminal. You can call this API to create a verification scheme.

Operation description

QPS limit

This API supports up to 100 calls per second per user. Exceeding this limit triggers rate limiting, which may affect your business. Use this API carefully.

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:CreateVerifyScheme

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
SchemeName

string

Yes

Scheme name.

一键登录认证方案
AppName

string

Yes

App name.

阿里云通信
OsType

string

Yes

Operating system type of the client. Valid values:

  • iOS

  • Android

  • Harmony

  • Web

iOS
PackName

string

No

Package name. Required when OsType is Android. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128 characters.

com.aliyun
PackSign

string

No

Package signature. Required when OsType is Android. Must contain only digits and letters. Length: 32 characters.

ecf65**********8ea68eda4c4a084cb
BundleId

string

No

Bundle ID. Required when OsType is iOS. Must contain only digits, letters, hyphens (-), underscores, or periods. Length: 1 to 128 characters.

example.aliyundoc.com
Origin

string

No

Source URL of the H5 scheme page. We recommend specifying the domain level.

https://h5.minexiot.com
Url

string

No

Page URL used by the H5 scheme.

https://h5.minexiot.com/
IpWhiteList

string

No

IP address whitelist. Optional.

139.9.xx.xx 122.112.xx.xx 139.9.xx.xx/24
CmApiCode

integer

No

China Mobile channel code. Optional.

1
CuApiCode

integer

No

China Unicom channel code. Optional.

2
CtApiCode

integer

No

China Telecom channel code. Optional.

3
SceneType

string

No

Scheme type. Optional.

0
Email

string

No

Email address to receive the key. Optional.

username@aliyundoc.com
AuthType

string

No

Authentication type. Optional. Select multiple values only if number authentication is supported. Separate multiple values with commas.

  • 1: Number authentication.

  • 2: Text message authentication.

1,2
SmsSignName

string

No

Bound text message signature. Valid only if AuthType includes 2 (text message authentication). The signature must be approved and created under the number authentication product.

阿里云短信测试专用
HmPackageName

string

No

Package name. Required when OsType is Harmony. Must contain only digits, letters, underscores, or periods. Must start with a letter. Length: 7 to 127 characters.

com.aliyun.harmonydemo
HmSignName

string

No

Package signature. Required when OsType is Harmony. Must contain only digits and letters. Length: 64 characters.

65C0B**********D4E80A135636F9A17AFFB540E4E9D2520DC095B68120EA812
HmAppIdentifier

string

No

App ID. Required when OsType is Harmony. Length: 19 digits.

57658*********34905

Response elements

Element

Type

Description

Example

object

Message

string

Description of the status code.

请求成功
RequestId

string

The ID of this API call, a unique identifier generated by Alibaba Cloud for this request. Use it to troubleshoot issues.

A1E75E69-3049-5FDB-A376-D745837CD2B1
GateVerifySchemeDTO

object

Structure.

SchemeCode

string

Scheme code.

FC10001287****
HttpStatusCode

integer

HTTP status code.

200
Code

string

Status code.

OK
Success

boolean

Whether the request was successful.

  • true: The request succeeded.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "Message": "请求成功",
  "RequestId": "A1E75E69-3049-5FDB-A376-D745837CD2B1",
  "GateVerifySchemeDTO": {
    "SchemeCode": "FC10001287****"
  },
  "HttpStatusCode": 200,
  "Code": "OK",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
400 SchemeNumberOverLimit The maximum number of scheme is exceeded.
400 BundleIdConflict The specified bundleId already exists.
400 InvalidParameters The specified parameter is not valid.
400 InvalidAccountStatus Your account has been suspended.
400 RamPermissionDeny The user is not authorized to operate on the specified resource.
400 PackageSignedConflict The specified package signed already exists.
400 Unsupported.Account Your account has not activated the product. Your account not be opened the product.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.