功能描述
查询用户列表。
请求
请求示例
GET /user/v1/user/
{OrganizationId}
?with_belonging_teams={WithBelongingTeams}
&with_space_usage={WithSpaceUsage}
&keyword={Keyword}
&order_by={OrderBy}
&order_by_type={OrderByType}
&page={Page}
&page_size={PageSize}
&user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
UserToken:用户令牌,必选参数。
WithSpaceUsage:是否同时获取个人空间用量信息,
true|false
,默认 false
。WithBelongingTeams:是否同时获取用户所属的团队信息,
true|false
,默认 false
。Keyword:查询的手机号或昵称,如果不带 keyword 参数,则是查询组织下的所有用户。
Page:分页码,默认第一页,可选参数。
PageSize:分页大小,默认20,可选参数。
SortBy:排序方式,支持
role
| enabled
| nickname
,默认 role
。OrderByType:排列顺序,正序或倒序 desc or asc。
请求体
该请求无请求体。
响应
响应码
获取成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"totalNum": 15,"page": 2,"pageSize": 10,"contents": [ {"id": 1,"orgId": 1,"countryCode": "+86","phoneNumber": "18938921940","nickname": "inkie","email": "a@b.com","comment": "研发","enabled": true,"role": "admin","avatar": "//test.cos/xxx.jpg","allowPersonalSpace": true,"capacity": "100000","availableSpace": "90000"}]}
响应体字段说明:
id:整数,用户 ID。
countryCode:字符串,手机号国家码。
phoneNumber:字符串,手机号码。
nickname:字符串,昵称。
email:字符串,邮箱。
comment:字符串,备注。
role:字符串,用户角色,'superAdmin' | 'admin' | 'user'。
avatar:字符串,用户头像链接。
enabled:布尔值,是否禁用。
allowPersonalSpace:布尔值, 是否允许分配个人空间。
capacity:字符串,个人空间存储额度,单位 Byte,仅当 WithSpaceUsage = true 时返回。
availableSpace:字符串,个人空间剩余可使用存储额度,单位 Byte,仅当 WithSpaceUsage = true 时返回。
expireTime:null 或日期字符串,用户待删除时间。