Verify Code¶

对验证码进行验证。

前提条件¶

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

请求格式¶

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

请求参数（URI）¶

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

请求参数（Header）¶

名称	必需/可选	数据类型	描述
Authorization	必需	String	用户登录并选择 OU 后生成的 Access Token，以 Bearer Token 表示，其形式为 `Bearer {your token}`。可通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
code	必需	String	验证码。

响应参数¶

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

错误码¶

代码	描述
31400	缺少必要参数。
31410	验证码已过期。
31429	当前邮箱验证次数过多。
31430	验证码错误。

示例¶

请求示例¶

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

method: POST

headers: {"Authorization":"Bearer your_token"}

requestBody:
{"code": "your_code"}

返回示例¶

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