获取用户组列表

获取用户组列表

请求说明

请求地址	https://openapi.wps.cn/v7/groups
请求方法	GET
签名方式	KSO-1
权限要求	查询和管理用户组（应用授权） kso.group.readwrite 查询用户组（应用授权） kso.group.read 查询和管理用户组（用户授权） kso.group.readwrite 查询用户组（用户授权） kso.group.read

请求头（Header）

Header 名称	参数类型	是否必填	说明
Content-Type	string	是	使用：application/json
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：Bearer {access_token}

查询参数（Query）

名称	参数类型	是否必填	说明
dept_ids	array[string]	否	部门 id，获取部门关联的组 格式为 dept_ids={string_1}&dept_ids={string_2}
exclude_dept_ids	array[string]	否	排除某些部门关联的组 格式为 exclude_dept_ids={string_1}&exclude_dept_ids={string_2}
joined	boolean	否	获取用户加入的用户组
page_size	integer	否	分页大小
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历
source	array[string]	否	用户组的业务方来源，默认为 default 格式为 source={string_1}&source={string_2}
status	array[string]	否	用户组状态 enable：正常；recycled：回收站 格式为 status={string_1}&status={string_2}
type	array[string]	否	用户组类型，默认为 normal normal：普通用户组；dept：部门用户组；org_dynamic：企业动态用户组；org_normal：企业静态用户组 格式为 type={string_1}&type={string_2}
user_id	string	否	用户 id 没有指定，默认采用访问凭证对应的 user_id；有指定，需要满足访问者对该 user_id 的用户组有权限的条件
user_role	array	否	按用户在组内的角色筛选组
with_total	boolean	否	是否返回 total 字段，默认不返回

请求地址示例

[GET] https://openapi.wps.cn/v7/groups?dept_ids={string_1}&dept_ids={string_2}&exclude_dept_ids={string_1}&exclude_dept_ids={string_2}&joined={boolean}&page_size={integer}&page_token={string}&source={string_1}&source={string_2}&status={string_1}&status={string_2}&user_id={string}&user_role={string_1}&user_role={string_2}&with_total={boolean}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ items	array[object]	用户组列表
∟ ∟ avatar	string	头像
∟ ∟ company_id	string	组织 id
∟ ∟ creator_id	string	创建者 id，创建时即确定，不被修改
∟ ∟ ctime	integer	创建时间
∟ ∟ dept_id	string	关联部门 id，默认 0
∟ ∟ description	string	描述介绍
∟ ∟ id	string	组 id
∟ ∟ member_total	integer	成员数量
∟ ∟ mtime	integer	更新时间
∟ ∟ name	string	名称
∟ ∟ owner_id	string	拥有者 id
∟ ∟ source	string	用户组的引用业务方
∟ ∟ status	string[enum]	用户组状态 enable：正常；recycled：回收站
∟ type	string[enum]	类型 normal：普通用户组；dept：部门用户组；org_dynamic：企业动态用户组；org_normal：企业静态用户组
∟ next_page_token	string	下一页的 token
∟ total	integer	数据总数
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "avatar": "string",
        "company_id": "string",
        "creator_id": "string",
        "ctime": 0,
        "dept_id": "string",
        "description": "string",
        "id": "string",
        "member_total": 0,
        "mtime": 0,
        "name": "string",
        "owner_id": "string",
        "source": "string",
        "status": "string[enum]",
        "type": "string[enum]"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "msg": "string"
}