Send Verification Code¶

向用户邮箱发送验证码。

前提条件¶

用户已登录应用门户，并进入一个 OU。如有需要，可通过 Log In API 登录应用门户，通过 Choose Organization API 选择 OU。

POST https://{apigw-address}/app-portal-service/v2.3/verificationCode/send

名称	必需/可选	数据类型	描述
type	必需	String	用户验证类型。仅支持赋值 `mfa`，即双因子验证。

名称

必需/可选

数据类型

描述

accessToken

必需

String

用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 Bearer {your token}。可通过调用 Log In 或 Refresh Access Token 接口后获取。

locale

可选

String

指定以何种语言返回列表信息，支持以下赋值：

en_US：英语

zh_CN：中文

es_ES：西班牙语

ja_JP：日语

de_DE：德语

pl_PL：波兰语

默认返回英语 en_US 的列表信息。

名称	数据类型	描述
success	Boolean	验证码是否发送成功。`true` 为发送成功，`false` 为发送失败。

代码	描述
31400	缺少必要参数。
31429	当前 IP 地址尝试发送验证码次数过多。尝试向目标邮箱发送验证码次数过多。

url: https://{apigw-address}/app-portal-service/v2.3/verificationCode/send?type=mfa

method: POST

headers: {"accessToken":"Bearer your_token"}

{
  "code": 0,
  "message": "OK",
  "data": {
    "success":true
  }
}