功能描述
用于在指定媒体库下创建用户
接口说明
userId 不允许使用保留字 me。可在请求体中通过
groups 指定用户初始加入的群组列表。请求
请求示例
POST /api/v1/user/{LibraryId}?access_token={AccessToken}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | 媒体库 ID | String | 是 |
AccessToken | 访问令牌 | String | 是 |
请求体
application/json
请求体示例：
{"userId": "user_001","nickName": "张三","userName": "zhangsan","countryCode": "+86","phone": "13800138000","email": "zhangsan@example.com","role": "user","status": "enabled","avatar": "https://example.com/avatar.jpg","description": "描述信息","userData": {},"groups": []}
请求体字段说明：
请求参数 | 描述 | 类型 | 是否必选 |
userId | 用户唯一标识，最长 64 字符，不允许使用保留字 me | String | 是 |
nickName | 昵称，最长 128 字符 | String | 否 |
userName | 用户名，最长 128 字符 | String | 否 |
countryCode | 国家/地区电话区号，带 + 前缀（如 +86、+1、+852），最长 8 字节，格式为 + + 1~3 位数字；可选参数，不传时默认为 +86 | String | 否 |
phone | 手机号（不含国家区号，国家区号请使用 countryCode 字段） | String | 否 |
email | 邮箱 | String | 否 |
role | 角色，默认 user，取值：user / admin / superadmin | String | 否 |
status | 状态，默认 enabled，取值：enabled / disabled | String | 否 |
avatar | 头像地址，支持两种格式：http/https URL 格式时最长 4KB； data:// base64 格式时最长 300KB | String | 否 |
description | 描述，最长 1024 字节 | String | 否 |
userData | 用户自定义数据，最长 JSON 序列化后 1024 字节 | Object | 否 |
groups | 初始加入的群组列表，最多 10 个 | Array | 否 |
响应
响应码
创建成功，返回 HTTP 201 Created
响应体
application/json
响应体示例：
{"libraryId": "lib_xxx","userId": "user_001","nickName": "张三","userName": "zhangsan","countryCode": "+86","phone": "13800138000","email": "zhangsan@example.com","role": "user","status": "enabled","avatar": "https://example.com/avatar.jpg","description": "描述信息","userData": {},"creator": "admin_001","creationTime": "2024-01-01T10:00:00.000Z","modifyTime": "2024-01-01T10:00:00.000Z"}
响应体字段说明：
节点名称（关键字） | 描述 | 类型 |
libraryId | 媒体库 ID | String |
userId | 用户唯一标识 | String |
nickName | 昵称 | String |
userName | 用户名 | String |
countryCode | 国家/地区电话区号，带 + 前缀（如 +86） | String |
phone | 手机号（不含国家区号） | String |
email | 邮箱 | String |
role | 角色： user / admin / superadmin | String |
status | 状态： enabled / disabled | String |
avatar | 头像地址 | String |
description | 描述 | String |
userData | 用户自定义数据 | Object |
creator | 创建者用户 ID | String |
creationTime | 创建时间，ISO 8601 格式，例如 2024-01-01T10:00:00.000Z | String |
modifyTime | 最后修改时间，ISO 8601 格式 | String |
错误码
错误码 | HTTP 状态码 | 说明 |
InvalidParameter | 400 | 请求参数不满足要求（包括字段长度超限、 userId 为保留字 me、countryCode 格式不合法等） |
GroupNotFound | 400 | groups 中存在不存在的 groupId |
UserAlreadyExist | 409 | 该 libraryId 下 userId 已存在 |
InternalError | 500 | 内部错误，请重试 |
