读取菜单权限目录接口
将 <BASE_URL> 替换为所在企业环境的 API 域名。
- Scope:
admin.v1.admin-roles.read - 权限项:管理员角色读取(
admin-roles) - 权限类型:读取
- 接口: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 |
请求参数
此接口没有额外请求参数。
请求示例
cURL
curl --request GET \
--url '<BASE_URL>/api/openapi/v1/admin-menu-permissions' \
--header 'Authorization: Bearer <API_KEY>'响应
200 OK
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
menus | array | null | 是 | - | [{"code":"<string>","display_order":0,"parent_code":"<string>"}] |
permissions | array | null | 是 | - | [{"action":"<string>","code":"<string>","description":"<string>","menu_code":"<string>","resource":"<string>"}] |
响应示例
{
"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
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
code | string | 否 | Stable business error code | "<string>" |
detail | string | 是 | Human-readable error description | "<string>" |
details | OpenapiErrorDetails | 否 | - | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
details.field | string | 否 | Request field that failed validation | "<string>" |
details.reason | string | 否 | Stable validation failure reason | "<string>" |
details.suggestion | string | 否 | Suggested normalized value | "<string>" |
error | string | 是 | Stable HTTP error type | "<string>" |
响应示例
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}