Skip to main content

查询用户组接口

查询组织中已有的用户组，返回名称、说明及直接用户数和部门数。可先用此接口取得用户组标识，再维护其成员或将其用于策略范围。

  • Scope：admin.v1.user-groups.read
  • 权限项：用户组读取（user-groups）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/user-groups

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/user-groups?keyword=<keyword>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是用户组列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
total_itemsinteger · int64是总条数0
total_pagesinteger · int64是总页数0

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
created_atstring · date-time是创建时间
department_countinteger · int64是包含的部门数量
descriptionstring是说明
direct_user_countinteger · int64是直接加入的用户数量
idstring是用户组 ID
namestring是用户组名称
updated_atstring · date-time是更新时间
{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "department_count": 0,
      "description": "<string>",
      "direct_user_count": 0,
      "id": "<string>",
      "name": "<string>",
      "updated_at": "2026-08-27T10:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_items": 0,
  "total_pages": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}