功能描述
用于查询指定用户的详细信息
接口说明
UserId 可传 me,返回当前 AccessToken 对应的登录用户信息。请求
请求示例
GET /api/v1/user/{LibraryId}/{UserId}?access_token={AccessToken}
请求参数
请求参数 | 描述 | 类型 | 是否必选 |
LibraryId | 媒体库 ID,必选参数; | String | 是 |
UserId | 用户 ID,必选参数;可传 me 以获取当前 AccessToken 对应的用户信息; | String | 是 |
AccessToken | 访问令牌,必选参数; | String | 是 |
请求体
无
响应
响应码
获取成功,返回 HTTP 200 OK
响应体
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 状态码 | 说明 |
UserNotFound | 404 | 用户不存在 |