获取代码动作清单角色授权状态
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/18-获取角色授权状态.md
详细说明
用于读取指定运行上下文在当前模块代码动作清单下的页面码、动作码授权状态。该接口只服务代码动作清单授权场景,不作为下游业务菜单授权状态主入口。
下游业务模块的已发布菜单授权状态必须使用 GET /sys_base/platform/manifest/getPublishedMenuAuthorityStatus 读取;PCWEB 在非 sys_base 模块下也必须展示“已发布菜单授权”来源。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | GET |
| 请求路径 | /sys_base/platform/manifest/getAuthorityCodeActionStatus |
| 来源文件 | 接口文档/18-获取角色授权状态.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
x-token | <jwt-token> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
本接口无请求体参数。
参数说明
- 当前会话读取自身权限状态时,允许不显式传
accessMode和authorityId,后端按当前 claims 自动补齐。 super_admin上下文只允许authorityId=0。- 当前会话若运行在普通角色上下文,查询自己当前角色状态属于正式允许场景。
请求示例
当前文档未提供独立请求示例,请参考下方 curl 示例。
响应输出
json
{
"code": 0,
"msg": "操作成功",
"data": {
"summary": {
"supported": true,
"addonsType": "sys_base",
"authorityId": 20,
"isSuperAdminRole": false,
"pageCount": 16,
"grantedPageCount": 2,
"actionCount": 38,
"grantedActionCount": 6,
"partialActionCount": 0,
"missingActionCount": 32,
"compareScope": "code_manifest_actions",
"compareNote": "对照当前模块代码动作清单,检查页面与动作覆盖情况。"
},
"publishSummary": {
"supported": true,
"addonsType": "sys_base",
"published": true
},
"list": [
{
"pageCode": "organization.department.manage",
"pageTitle": "部门管理",
"menuFlag": "department",
"routeName": "department",
"routePath": "authority/department",
"pageGranted": true,
"actions": [
{
"actionCode": "department.create",
"actionTitle": "新增部门",
"grantStatus": "granted"
}
]
}
]
}
}字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
data.summary.authorityId | number | 本次对照的目标角色 ID,super_admin 模式下固定为 0 |
data.summary.isSuperAdminRole | boolean | 本次是否按 super_admin 上下文返回状态 |
data.summary.grantedPageCount | number | 当前上下文已放行的正式页面数量 |
data.summary.grantedActionCount | number | 当前上下文已放行的正式动作数量 |
data.publishSummary | object | 当前模块正式菜单清单发布摘要 |
data.list[].pageCode | string | 正式页面码 |
data.list[].pageGranted | boolean | 当前页面是否放行 |
data.list[].actions[].actionCode | string | 正式动作码 |
data.list[].actions[].grantStatus | string | 动作授权状态,正式取值为 granted、partial、missing |
curl 示例
bash
curl --location --request GET 'http://127.0.0.1:8100/sys_base/platform/manifest/getAuthorityCodeActionStatus?addonsType=sys_base&accessMode=role&authorityId=20' \
--header 'x-token: <jwt-token>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base'