Log In¶
使用账号密码登录应用门户。
如果当前账号可访问多个 OU,或需获取账号登录后的 Access Token 用于身份验证,后续你需要调用 Choose Organization API 选择要进入的 OU。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/login
请求参数(Body)¶
| 名称 | 必需/可选 | 数据类型 | 描述 | 
|---|---|---|---|
| account | 必需 | String | 用户名。 | 
| password | 必需 | String | 登录密码。 | 
响应参数¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| organizations | List<JSONObject> | 用户所在的 OU 列表。详见 IdNamePair 结构体。后续可通过 Choose Organization API 选择需要进入的 OU。 | 
| user | List<JSONObject> | 用户信息。IdNamePair 结构体 >> | 
| accessToken | String | 用户登录并选择 OU 后生成的 Access Token,仅用于后续通过 Choose Organization API 选择 OU,无法用于用户身份验证。 | 
| mfaType | String | 当前用户的双因子认证类型。 | 
IdNamePair 结构体¶
| 名称 | 数据类型 | 描述 | 
|---|---|---|
| id | String | 用户 ID 或 OU ID。 | 
| name | String | 用户名称或 OU 名称。 | 
| String | 用户邮箱。 | 
错误码¶
| 代码 | 错误信息 | 描述 | 
|---|---|---|
| 31400 | The user name or password is wrong | 用户账号密码不能为空或者填写错误 | 
| 31429 | / | 密码或 IP 错误次数过多,请稍后重试 | 
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/login
method: POST
requestBody:
{"account":"portal_demo","password":"Test1234"}
返回示例¶
{
  "code": 0,
  "data": {
    "accessToken": "your_access_token",
    "mfaType": "NONE",
    "organizations": [
      {
        "id": "your_org_id_1",
        "name": "your_org_name_1"
      },
      {
        "id": "your_org_id_2",
        "name": "your_org_name_2"
      }
    ],
    "user": {
      "id": "your_user_id",
      "name": "your_user_name",
      "email": "your_email"
    }
  },
  "message": "OK"
}