查询用户组列表

通过该接口可查询企业的用户组列表，如果应用的通讯录权限范围是“全部员工”，则可获取企业全部用户组列表。如果应用的通讯录权限范围不是“全部员工”，则仅可获取通讯录权限范围内的用户组。点击了解通讯录权限范围。

错误码

HTTP状态码	错误码	描述	排查建议
500	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
400	40011	page size is invalid	无效的分页参数
400	40012	page token is invalid error	page token无效。

{ "code": 0, "msg": "success", "data": { "grouplist": [ { "id": "g193821", "name": "IT 外包组", "description": "IT 外包组，需要对该组人群进行细颗粒度权限管控。", "member_user_count": 2, "member_department_count": 0 } ], "page_token": "AQD9/Rn9556539ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JDTJJDDPw=", "has_more": true } }

请求参数

Query 参数

page_size

string

可选

分页大小示例值：50 数据校验规则：最大值：100

示例值:

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw="

示例值:

AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=

type

string

可选

用户组类型示例值：1 可选值有： 1：普通用户组默认值：1

示例值:

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

grouplist

array [object {5}]

用户组列表

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

has_more

boolean

是否还有更多项

必需

查询用户组列表

错误码#

请求参数

返回响应

错误码