認(rèn)證方案用于標(biāo)識(shí)App下的認(rèn)證場(chǎng)景,一般一個(gè)認(rèn)證方案對(duì)應(yīng)一個(gè)App名稱、App包名、包簽名等信息(接入端不同對(duì)應(yīng)所需參數(shù)也不同),調(diào)用本接口創(chuàng)建認(rèn)證方案。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dypns:CreateVerifyScheme | create |
|
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SchemeName | string | 是 | 方案名稱。 | 一鍵登錄認(rèn)證方案 |
AppName | string | 是 | App 名稱。 | 阿里云通信 |
OsType | string | 是 | 終端操作系統(tǒng)類型,取值:iOS、Android 或 Web。 | iOS |
PackName | string | 否 | 包名,osType 為 Android 時(shí)必選。由數(shù)字、字母、短劃線(-)、下劃線或點(diǎn)組成,長(zhǎng)度限制為 1~128 個(gè)字符。 | com.aliyun |
PackSign | string | 否 | 包簽名,osType 為 Android 時(shí)必選。由數(shù)字和字母組成,長(zhǎng)度為 32 個(gè)字符。 | 123aliyun |
BundleId | string | 否 | BundleID,osType 為 iOS 時(shí)必選。由數(shù)字、字母、短劃線(-)、下劃線或點(diǎn)組成,長(zhǎng)度限制為 1~128 個(gè)字符。 | example.aliyundoc.com |
Origin | string | 否 | H5 方案頁面源地址(建議填寫域名級(jí)別)。 | https://h5.minexiot.com |
Url | string | 否 | H5 方案使用的頁面地址。 | https://h5.minexiot.com/ |
IpWhiteList | string | 否 | IP 白名單,默認(rèn)可不填。 | 139.9.xx.xx 122.112.xx.xx 139.9.xx.xx/24 |
CmApiCode | long | 否 | 中國移動(dòng)通道 Code,默認(rèn)可不填。 | 1 |
CuApiCode | long | 否 | 中國聯(lián)通通道 Code,默認(rèn)可不填。 | 2 |
CtApiCode | long | 否 | 中國電信通道 Code,默認(rèn)可不填。 | 3 |
SceneType | string | 否 | 方案類型,默認(rèn)可不填。 | 0 |
string | 否 | 密鑰獲取接收郵箱地址,默認(rèn)可不填。 | username@aliyundoc.com | |
AuthType | string | 否 | 認(rèn)證類型,默認(rèn)不填,只有支持號(hào)碼認(rèn)證時(shí)可多選,以英文逗號(hào)間隔。
| 1,2 |
SmsSignName | string | 否 | 綁定的短信簽名,只有 AuthType 包含 2(短信認(rèn)證)時(shí)才有效,且簽名必須是號(hào)碼認(rèn)證產(chǎn)品下創(chuàng)建的已經(jīng)審核通過的。 | 阿里云短信測(cè)試專用 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Message": "請(qǐng)求成功",
"RequestId": "A1E75E69-3049-5FDB-A376-D745837CD2B1",
"GateVerifySchemeDTO": {
"SchemeCode": "FC10001287****"
},
"HttpStatusCode": 200,
"Code": "OK",
"Success": true
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | SchemeNumberOverLimit | The maximum number of scheme is exceeded. | 號(hào)碼認(rèn)證方案數(shù)量超過限制 |
400 | BundleIdConflict | The specified bundleId already exists. | bundleId已存在 |
400 | InvalidParameters | The specified parameter is not valid. | 參數(shù)無效 |
400 | InvalidAccountStatus | Your account has been suspended. | 您的賬號(hào)已被停機(jī)。 |
400 | RamPermissionDeny | The user is not authorized to operate on the specified resource. | 沒有訪問權(quán)限 |
400 | PackageSignedConflict | The specified package signed already exists. | 包名簽名已存在 |
400 | Unsupported.Account | Your account has not activated the product. | 你的賬號(hào)沒有開通本產(chǎn)品。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-10-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-06-07 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2022-11-24 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |