Update User Information¶
更新用户信息。
请求参数(URI)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
orgId | 必需 | String | 组织 ID。 |
userId | 可选 | String | 用户 ID,不可与 userName 同时为空。 |
userName | 可选 | String | 用户名,不可与 userId 同时为空。 |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
phone | 可选 | String | 用户的手机号。 |
nickName | 可选 | String | 用户的昵称。 |
phoneArea | 可选 | String | 用户手机号的所属区号。 |
company | 可选 | String | 用户的公司。 |
position | 可选 | String | 用户的职位。 |
department | 可选 | String | 用户的部门。 |
可选 | String | 用户的邮箱。若目标账号为域账号,且所在域的账号以邮箱为唯一标识,则该项不可修改。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | Data 结构体 | 修改后的用户信息。 |
Data 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
nickName | String | 用户的昵称。 |
description | String | 用户的描述。 |
isInitPassword | Boolean | 用户密码是否为初始密码。 |
phone | String | 用户的手机号。 |
domain | String | 用户所属的域。 |
name | String | 用户名。 |
phoneArea | String | 用户手机号的所属区号。 |
createdTime | String | 用户创建时间。 |
theme | String | 主题。 |
company | String | 用户的公司。 |
id | String | 用户 ID。 |
position | String | 用户的职位。 |
department | String | 用户的部门。 |
String | 用户的邮箱。 |
错误码¶
代码 | 描述 |
---|---|
31400 | 组织 ID 为空,userId 和 userName 同时为空,email 重复,手机号、邮箱、区号不合法。 |
31404 | 组织 ID 、用户 ID 或用户名不存在;用户不在组织中。 |
示例¶
请求示例¶
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"
}