查询部门下用户列表
请求说明
请求地址: 配置域名+/graph+/v7/depts/{dept_id}/members请求方法: 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值 |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| dept_id | string | 是 | 部门id,字符串长度不超过128位 |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| recursive | boolean | 否 | true: 递归查询子部门 false: 不递归查询子部门 默认为:false |
| page_size | integer | 否 | 分页大小,默认为:10,最大值:50 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 |
| with_total | boolean | 否 | true: 返回总记录数 false: 不返回总记录数 默认为:false |
| with_user_detail | boolean | 否 | true: 返回用户详细信息 false: 不返回用户详细信息 默认为:false |
| status | object[] | 是 | 用户状态,可选值: active - 正常 notactive - 未激活 disabled - 禁用 |
响应体(Response)
| 名称 | 类型 | 说明 | | ---------------------------------------------------------- | :------: | --------------------------------------------------------- | ------ | -------- | | code | integer | code | | detail | string | detail | | msg | string | msg | | data | object | 返回信息体 | | ∟ items | object[] | 部门成员 | | ∟ ctime | integer | 创建时间,时间戳,单位为秒 | | ∟ dept_id | string | 部门id列表 | | ∟ mtime | integer | 修改时间 | | ∟ order | integer | 部门内的排序值 | | ∟ user_id | string | 用户id | | ∟ user_info | object | 部门成员简单信息 | | ∟ company_id | string | 企业ID | | ∟ login_name | string | 登录名 | | ∟ user_name | string | 用户名 | | ∟ gender | object | 性别 ∟ avatar | string | 账户头像 | | ∟ email | string | 邮箱 | | ∟ phone | string | 手机号码 | | ∟ title | string | 职务信息 | | ∟ work_place | string | 办公地点 | | ∟ employee_id | string | 工号 | | ∟ telephone | string | 座机 | | ∟ status | object | 用户状态 | | ∟ next_page_token | string | 下一页token | | ∟ total | integer | 返回总记录数 |
响应体示例
{
"code": 0,
"detail": "string",
"msg": "string",
"data": {
"items": [
{
"ctime": 0,
"dept_id": "string",
"mtime": 0,
"order": 0,
"user_id": "string",
"user_info": {
"company_id": "c01",
"login_name": "jack",
"user_name": "jack",
"gender": "male",
"avatar": "string",
"email": "123456789@wps.cn",
"phone": "13612345678",
"title": "string",
"work_place": "wuhan",
"employee_id": "e01",
"telephone": "021-12345678",
"status": ["active"]
}
}
],
"next_page_token": "string",
"total": 0
}
}