Skip to main content

读取菜单权限目录接口

读取管理后台菜单及其权限编码目录。创建或更新管理员角色前，可用此接口确认 permissions 可填写的权限及其所属菜单。

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

认证与请求头

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

目录语义

目录不再包含 biz.administration、subscription.usage-details 两个旧菜单及其退役权限码。biz.catalog.manage 保留并归属 assets.skills；控制台勾选技能并保存时，一并授予官方目录供给配置和资源包导入权限。 目录中的 License 权限仅供超级管理员使用，不参与普通角色菜单授权计数。

请求参数

此接口没有额外请求参数。

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/admin-menu-permissions' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
menusarray ｜ null是菜单权限-
permissionsarray ｜ null是权限-
以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
codestring是菜单编码
display_orderinteger · int64是显示顺序
parent_codestring否父级菜单编码

permissions[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
actionstring是权限动作
codestring是权限编码
descriptionstring是描述
menu_codestring是关联菜单编码
resourcestring是权限控制的资源
{
  "menus": [
    {
      "code": "<string>",
      "display_order": 0,
      "parent_code": "<string>"
    }
  ],
  "permissions": [
    {
      "action": "<string>",
      "code": "<string>",
      "description": "<string>",
      "menu_code": "<string>",
      "resource": "<string>"
    }
  ]
}

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>"
}