Skip to content

查询部门下用户列表

适用版本>=v7.0.2305a.20230511

接口说明:获取部门成员列表

请求说明

请求地址配置域名+/graph+/v7/depts/{dept_id}/members
请求方法GET
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求通讯录查询(企业授权) kso.contacts.read

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间,示例: Wed,23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
dept_idstring部门id,字符串长度不超过128位

查询参数(Query)

名称类型是否必填说明
recursivebooleantrue: 递归查询子部门 false: 不递归查询子部门 默认为:false
page_sizeinteger分页大小,默认为:10,最大值:50
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果
with_totalbooleantrue: 返回总记录数 false: 不返回总记录数 默认为:false
with_user_detailbooleantrue: 返回用户详细信息 false: 不返回用户详细信息 默认为:false
statusstring[]用户状态,可选值: active - 正常 notactive - 未激活 disabled - 禁用

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject返回信息体
itemsobject[]部门成员
ctimeinteger创建时间,时间戳,单位为秒
dept_idstring部门id列表
mtimeinteger修改时间,时间戳,单位为秒
orderinteger部门内的排序值
user_idstring用户id
user_infoobject部门成员简单信息
company_idstring企业ID
login_namestring登录名
user_namestring用户名
genderstring性别
avatarstring头像
emailstring邮箱
phonestring手机号码
titlestring职务信息
work_placestring办公地点
employee_idstring工号
telephonestring座机
statusstring用户状态
rolestring用户角色
super-admin:超级管理员;admin:普通管理员;normal:普通用户;
next_page_tokenstring下一页token;当查询结果中next_page_token为空或无该返回值时,代表无下一页
totalinteger返回总记录数

响应体示例

json
{
  "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",
          "role": "active"
        }
      }
    ],
    "next_page_token": "string",
    "total": 0
  }
}