读取菜单权限目录接口
读取管理后台菜单及其权限编码目录。创建或更新管理员角色前,可用此接口确认 permissions 可填写的权限及其所属菜单。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|---|---|---|
| 管理员角色读取(读取) | admin-roles | admin.v1.admin-roles.read | qwenwork-biz-service |
GET /api/openapi/v1/admin-menu-permissions
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
此接口没有额外请求参数。
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request GET --url '<BASE_URL>/api/openapi/v1/admin-menu-permissions' --header 'Authorization: Bearer <API_KEY>'响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| menus | array | null | 是 | 管理后台的菜单目录。 | [{"code":"<string>","display_order":0,"parent_code":"<string>"}] |
| menus[].code | string | 是 | 权限或菜单的稳定编码。 | "<string>" |
| menus[].display_order | integer · int64 | 是 | 展示顺序的排序值。 | 0 |
| menus[].parent_code | string | 否 | 上级菜单的编码,用于还原目录层级。 | "<string>" |
| permissions | array | null | 是 | 可用于管理员角色授权的权限目录。 | [{"action":"<string>","code":"<string>","description":"<string>","menu_code":"<string>","resource":"<string>"}] |
| permissions[].action | string | 是 | 该权限允许执行的操作。 | "<string>" |
| permissions[].code | string | 是 | 权限或菜单的稳定编码。 | "<string>" |
| permissions[].description | string | 是 | 此对象的说明,用于补充名称之外的信息。 | "<string>" |
| permissions[].menu_code | string | 是 | 权限所属菜单的编码。 | "<string>" |
| permissions[].resource | string | 是 | 该权限控制的资源类型。 | "<string>" |
{
"menus": [
{
"code": "<string>",
"display_order": 0,
"parent_code": "<string>"
}
],
"permissions": [
{
"action": "<string>",
"code": "<string>",
"description": "<string>",
"menu_code": "<string>",
"resource": "<string>"
}
]
}default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}