文档

CreateVerifyScheme - 创建认证方案

更新时间:

调用CreateVerifyScheme创建认证方案。

接口说明

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypns:CreateVerifySchemeWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SchemeNamestring

方案名称。

一键登录认证方案
AppNamestring

App 名称。

阿里云通信
OsTypestring

终端操作系统类型,取值:iOS、Android 或 Web。

iOS
PackNamestring

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

com.aliyun
PackSignstring

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

123aliyun
BundleIdstring

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

example.aliyundoc.com
Originstring

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

https://h5.minexiot.com
Urlstring

H5 方案使用的页面地址。

https://h5.minexiot.com/
IpWhiteListstring

IP 白名单,默认可不填。

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

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

1
CuApiCodelong

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

2
CtApiCodelong

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

3
SceneTypestring

方案类型,默认可不填。

0
Emailstring

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

username@aliyundoc.com
AuthTypestring

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

  • 1:号码认证

  • 2:短信认证

1,2
SmsSignNamestring

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

阿里云短信测试专用

返回参数

名称类型描述示例值
object
Messagestring

状态码的描述。

请求成功
RequestIdstring

请求 ID。

A1E75E69-3049-5FDB-A376-D745837CD2B1
GateVerifySchemeDTOobject

结构体。

SchemeCodestring

方案号。

FC10001287****
HttpStatusCodelong

HTTP 状态码。

200
Codestring

状态码。

OK
Successboolean

请求是否成功。

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400SchemeNumberOverLimitThe maximum number of scheme is exceeded.号码认证方案数量超过限制
400BundleIdConflictThe specified bundleId already exists.bundleId已存在
400InvalidParametersThe specified parameter is not valid.参数无效
400InvalidAccountStatusYour account has been suspended.您的账号已被停机。
400RamPermissionDenyThe user is not authorized to operate on the specified resource.没有访问权限
400PackageSignedConflictThe specified package signed already exists.包名签名已存在
400Unsupported.AccountYour account has not activated the product.你的账号没有开通本产品。

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

变更历史

变更时间变更内容概要操作
2023-06-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-11-24OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Origin
    新增入参:Url
    新增入参:IpWhiteList
    新增入参:CmApiCode
    新增入参:CuApiCode
    新增入参:CtApiCode
    新增入参:SceneType
    新增入参:Email
    新增入参:SmsSignName
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈