文档

UpdateUser - 更新用户信息

更新时间:

通过 OpenAPI 更新用户信息。

适用版本

企业专属版

服务接入点与授权信息

请求语法

PUT  https://<domain>/oapi/v1/platform/users/<idOrUsername>

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

idOrUsername

string

path

用户 ID 或登录账号。

f5b8****7a1c

email

string

body

邮箱。

name

string

body

显示用户名。

nickName

string

body

昵称。

operatorId

string

body

使用非个人访问令牌如应用访问令牌调用时,需指定操作人。

password

string

body

密码。

staffId

string

body

员工 ID。

sysDeptIds

string

body

为空表示不更新部门信息。

请求示例

curl -X 'PUT' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/users/f5b8****7a1c' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  -d '{
  "email": "string",
  "name": "string",
  "nickName": "string",
  "operatorId": "string",
  "password": "string",
  "staffId": "string",
  "sysDeptIds": [
    "string"
  ]
}'

返回参数

参数

类型

描述

示例值

email

string

邮箱。

id

string

用户 ID。

8446****ce9f

lastOrganization

string

最后加入的组织。

name

string

名称。

name1

nickName

string

昵称。

lingma

staffId

string

员工 ID。

sysDeptIds

string

部门 ID。

username

string

用户名。

lingma2

返回示例

{
  "email": "string",
  "id": "8446****ce9f",
  "lastOrganization": "string",
  "name": "name1",
  "nickName": "lingma",
  "staffId": "string",
  "sysDeptIds": [
    "string"
  ],
  "username": "lingma2"
}

错误码

访问错误码中心查看 API 相关错误码。