# 修改用户 API

修改用户属性,使用 POST 发起请求,请求地址为 /api/v1/users/{id}/actions/update

POST /api/v1/users/{id}/actions/update

# 请求 URI

参数名 位置 类型 必填 说明
id path 整数 用户 Id
apiKey query 字符串 API 密钥,请参考身份认证

# 请求 Body

参数名 类型 必填 说明
userName 字符串 用户账号
groupId 整数 用户组 Id
checked 字符串 是否已审核
locked 字符串 是否被锁定
displayName 字符串 用户姓名
mobile 字符串 手机号
email 字符串 邮箱
avatarUrl 字符串 头像图片路径
openId 字符串 微信用户的标识,对当前公众号唯一

# 返回

名称 类型 说明
200 OK User 用户
401 Unauthorized Error 认证错误
404 NotFound Error 资源不存在错误
400 BadRequest Error 参数错误

# 示例

# 请求示例

POST /api/v1/users/1/actions/update
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf

{
  "userName": "demo",
  "displayName": "用户名"
}

# 返回示例

{
  "id": 1,
  "userName": "demo",
  "password": "3CPlhZ8UAus=",
  "passwordFormat": "Encrypted",
  "createDate": "2018-06-17 14:18:45",
  "lastResetPasswordDate": "2018-06-17 14:18:45",
  "lastActivityDate": "2018-06-17 14:18:45",
  "countOfLogin": 0,
  "countOfFailedLogin": 0,
  "countOfWriting": 0,
  "checked": true,
  "locked": false,
  "displayName": "用户名",
  "email": "demo@sample.com",
  "mobile": "13888888888",
  "avatarUrl": "",
  "openId": ""
}
上次更新: 2023/11/16 上午11:17:30