CreateVerifyScheme - 创建认证方案

更新时间:
复制为 MD 格式

认证方案用于标识App下的认证场景,一般一个认证方案对应一个App名称、App包名、包签名等信息(接入端不同对应所需参数也不同),调用本接口创建认证方案。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dypns:CreateVerifyScheme

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SchemeName

string

方案名称。

一键登录认证方案

AppName

string

App 名称。

阿里云通信

OsType

string

终端操作系统类型,取值:

  • iOS

  • Android

  • Harmony

  • Web

iOS

PackName

string

包名,osType 为 Android 时必填。由数字、字母、短划线(-)、下划线或点组成,长度限制为 1~128 个字符。

com.aliyun

PackSign

string

包签名,osType 为 Android 时必填。由数字和字母组成,长度为 32 个字符。

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

BundleId

string

BundleID,osType 为 iOS 时必填。由数字、字母、短划线(-)、下划线或点组成,长度限制为 1~128 个字符。

example.aliyundoc.com

Origin

string

H5 方案页面源地址(建议填写域名级别)。

https://h5.minexiot.com

Url

string

H5 方案使用的页面地址。

https://h5.minexiot.com/

IpWhiteList

string

IP 白名单,默认可不填。

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

CmApiCode

integer

中国移动通道 Code,默认可不填。

1

CuApiCode

integer

中国联通通道 Code,默认可不填。

2

CtApiCode

integer

中国电信通道 Code,默认可不填。

3

SceneType

string

方案类型,默认可不填。

0

Email

string

密钥获取接收邮箱地址,默认可不填。

username@aliyundoc.com

AuthType

string

认证类型,默认不填,只有支持号码认证时可多选,以英文逗号间隔。

  • 1:号码认证。

  • 2:短信认证。

1,2

SmsSignName

string

绑定的短信签名,只有 AuthType 包含 2(短信认证)时才有效,且签名必须是号码认证产品下创建的已经审核通过的。

阿里云短信测试专用

HmPackageName

string

包名,osType 为Harmony时必填。由数字、字母、下划线或点组成.必须以字母开头,长度限制为 7~127 个字符。

com.aliyun.harmonydemo

HmSignName

string

包签名,osType 为Harmony时必填。由数字和字母组成,长度为 64 个字符。

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

HmAppIdentifier

string

AppId,osType 为Harmony时必填。长度为 19 位纯数字。

57658*********34905

返回参数

名称

类型

描述

示例值

object

Message

string

状态码的描述。

请求成功

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

A1E75E69-3049-5FDB-A376-D745837CD2B1

GateVerifySchemeDTO

object

结构体。

SchemeCode

string

方案号。

FC10001287****

HttpStatusCode

integer

HTTP 状态码。

200

Code

string

状态码。

OK

Success

boolean

请求是否成功。

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 SchemeNumberOverLimit The maximum number of scheme is exceeded. 号码认证方案数量超过限制
400 BundleIdConflict The specified bundleId already exists. bundleId已存在
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. 你的账号没有开通本产品。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情