列出所有用户
请求说明
请求地址: 配置域名+/graph+/v7/users请求方法: GET 签名方式: WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值 |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| page_size | integer | 否 | 分页大小,默认为:10,最大值:50 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 |
| with_total | boolean | 否 | true: 返回总记录数 false: 不返回总记录数 默认为:false |
| with_dept | boolean | 否 | true: 返回部门信息 false: 不返回部门信息 默认为:false |
| status | object[] | 是 | 用户状态,可选值: active - 正常 notactive - 未激活 disabled - 禁用 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 返回信息体 |
| ∟ items | object[] | 用户信息 |
| ∟ avatar | string | 头像 |
| ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ depts | object[] | 部门信息 |
| ∟ abs_path | string | 绝对路径 |
| ∟ id | string | 部门id.字符串长度不超过20位 |
| ∟ name | string | 部门名称.字符串长度不超过128位 |
| string | 邮箱.字符串长度不超过128位 | |
| ∟ employee_id | string | 工号.字符串长度不超过32位 |
| ∟ ex_user_id | string | 用户外部id,可以是用户ID、用户名、邮箱、手机号、外部ID、在外部身份源的ID,为空则默认为用户id.字符串长度不超过128位 |
| ∟ gender | object | 性别 |
| ∟ id | string | 用户id,自动生成.字符串长度不超过128位 |
| ∟ login_name | string | 登录名.字符串长度不超过128位 |
| ∟ phone | string | 手机 |
| ∟ status | object | 用户状态 |
| ∟ telephone | string | 座机.字符串长度不超过32位 |
| ∟ title | string | 职务信息.字符串长度不超过128位 |
| ∟ user_name | string | 用户名.字符串长度不超过128位 |
| ∟ work_place | string | 办公地点.字符串长度不超过128位 |
| ∟ next_page_token | string | 下一页token |
| ∟ total | integer | 总记录数 |
响应体示例
json
{
"code": 0,
"detail": "string",
"msg": "string",
"data": {
"items": [
{
"avatar": "string",
"ctime": 0,
"depts": [
{
"abs_path": "string",
"id": "string",
"name": "string"
}
],
"email": "user@example.com",
"employee_id": "string",
"ex_user_id": "string",
"gender": "string",
"id": "string",
"login_name": "string",
"phone": "string",
"status": "string",
"telephone": "string",
"title": "string",
"user_name": "string",
"work_place": "string"
}
],
"next_page_token": "string",
"total": 0
}
}