Skip to main content

查询管理员角色接口

查询管理员角色，返回角色名称、系统角色标记及成员数量。可用角色标识定位需要调整权限或成员的角色。

  • Scope：admin.v1.admin-roles.read
  • 权限项：管理员角色读取（admin-roles）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/admin-roles

认证与请求头

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

菜单数量

permission_count 按角色已有授权在当前权限树中对应的唯一菜单计数，同一菜单的多个权限只计一次，部分授权菜单也计一次。无权限的分组、已退役菜单及仅超级管理员可用的 License 不计入。数量描述角色配置；停用角色仍保留配置，但不会授予管理权限。

请求参数

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

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/admin-roles?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是创建时间
descriptionstring是说明
idstring是管理员角色 ID
member_countinteger · int64是成员数量
namestring是管理员角色名称
permission_countinteger · int64是权限数量
systemboolean是是否为系统内置角色
updated_atstring · date-time是更新时间
{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "description": "<string>",
      "id": "<string>",
      "member_count": 0,
      "name": "<string>",
      "permission_count": 0,
      "system": false,
      "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>"
}