帮你快速理解、总结文档立即下载

修改用户

最近更新时间:2026-10-27 17:33:38
本文档已由 AI 辅助审校
我的收藏

功能描述

用于修改指定用户的信息

接口说明

要求权限:仅 superadmin 可修改 role。
请求体中各字段均为可选,仅更新传入的字段。

请求

请求示例

POST /api/v1/user/{LibraryId}/{UserId}?access_token={AccessToken}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID,必选参数;
String
是
UserId
用户 ID,必选参数;
String
是
AccessToken
访问令牌,必选参数;
String
是

请求体

application/json,各字段均为可选,仅更新传入字段
请求体示例:
{
"nickName": "李四",
"userName": "lisi",
"countryCode": "+86",
"phone": "13900139000",
"email": "lisi@example.com",
"role": "admin",
"status": "enabled",
"avatar": "https://example.com/new-avatar.jpg",
"description": "新的描述信息",
"userData": {}
}
请求体字段说明:
请求参数
描述
类型
是否必选
nickName
字符串,昵称,最长 128 字符,可选参数;
String
否
userName
字符串,用户名,最长 128 字符,可选参数;
String
否
countryCode
字符串,国家/地区电话区号,带 + 前缀(如 +86、+1、+852),最长 8 字节,格式为 + + 1~3 位数字;可选参数;
String
否
phone
字符串,手机号(不含国家区号),可选参数;
String
否
email
字符串,邮箱,可选参数;
String
否
role
字符串,角色:user / admin / superadmin,可选参数;
String
否
status
字符串,状态:enabled / disabled,可选参数;
String
否
avatar
字符串,头像地址,可选参数;支持两种格式:http/https URL 格式时最长 4KB;data:// base64 格式时最长 300KB;
String
否
description
字符串,描述,最长 1024 字节,可选参数;
String
否
userData
对象,用户自定义数据,最长 1024 字节,可选参数;
Object
否

响应

响应码

修改成功,返回 HTTP 204 No Content

响应体

空,无响应体

错误码

错误码
HTTP 状态码
说明
UpdateRoleForbidden
403
非 superadmin 用户尝试修改 role 字段
UserNotFound
404
用户不存在