Update User Information¶

更新用户信息。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/user/info/update

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>
userId	Query	可选	String	用户 ID，不可与 `userName` 同时为空。如何获取 userId 信息 >>
userName	Query	可选	String	用户名，不可与 `userId` 同时为空。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
phone	可选	String	用户的手机号。
nickName	可选	String	用户的昵称。
phoneArea	可选	String	用户手机号的所属区号。
company	可选	String	用户的公司。
position	可选	String	用户的职位。
department	可选	String	用户的部门。
email	可选	String	用户的邮箱。若目标用户为域账号，且所在域的账号以邮箱为唯一标识，则该项不可修改，指定该参数无效。

响应参数¶

名称	数据类型	描述
nickName	String	用户的昵称。
description	String	用户的描述。
isInitPassword	Boolean	用户密码是否为初始密码。`true` 表示是初始密码，`false` 表示不是初始密码。
phone	String	用户的手机号。
domain	String	用户所属的域。
name	String	用户名。
phoneArea	String	用户手机号的所属区号。
createdTime	String	用户创建时间。
theme	String	界面的主题颜色。
company	String	用户的公司。
id	String	用户 ID。
position	String	用户的职位。
department	String	用户的部门。
email	String	用户的邮箱。
updatedTime	String	用户的更新时间。

错误码¶

代码

描述

31400

可能原因：

OU ID 为空。
userId 和 userName 同时为空。
email 重复。
手机号、邮箱或区号不合法。

31404

OU ID 、用户 ID 或用户名不存在。
用户不在 OU 中。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/info/update?userName=your_user_name&orgId=your_org_id

method: POST

requestBody:
{
  "phone": "your_phone_number",
  "nickName": "",
  "phoneArea": "+86",
  "company": "company",
  "position": "position",
  "department": "department",
  "email": "your_user_email"
}

返回示例¶

{
    "code": 0,
    "data": {
        "nickName": "",
        "description": "",
        "isInitPassword": false,
        "phone": "your_phone_number",
        "domain": "",
        "name": "your_name",
        "phoneArea": "+86",
        "createdTime": "2021-10-09 03:36:53.0",
        "theme": "DARK",
        "company": "company",
        "id": "your_user_id",
        "position": "position",
        "department": "department",
        "email": "your_user_email"
    },
    "message": "OK"
}