查看 Markdown
POST/api/security/permission/createRule

创建权限规则

创建一条新的工具权限规则。规则表达式格式: 工具名(参数模式),如 execute_shell(rm -rf *)

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)5 个字段

ruleTypestringrequired

规则类型,取值: ALLOW(允许)、ASK(人工确认)、DENY(拒绝)

ruleExpressionstringrequired

规则匹配表达式,格式: 工具名(参数模式),支持glob通配符。示例: execute_shell(rm -rf *)

agentIdintegerrequired

智能体ID

priorityintegernullable

优先级,数字越小优先级越高,默认100

descriptionstringrequired

规则用途说明

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataintegernullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/security/permission/batchCreateRules

批量创建权限规则

一次性创建多条权限规则,适用于智能生成后一键应用

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

agentIdintegerrequired

智能体ID

规则列表,最多50条

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataarraynullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/security/permission/listRules

查询权限规则列表

分页查询指定智能体的权限规则,支持按规则类型过滤

请求参数

Query 参数4 个字段

agentIdintegerrequired

智能体ID

ruleTypestringnullable

规则类型: ALLOW、ASK、DENY

pageintegernullable

页码,从1开始

pageSizeintegernullable

每页大小,默认20

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/security/permission/updateRule

更新权限规则

根据规则ID更新已有的权限规则

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)6 个字段

idintegerrequired

规则ID

ruleTypestringrequired

规则类型,取值: ALLOW(允许)、ASK(人工确认)、DENY(拒绝)

ruleExpressionstringrequired

规则匹配表达式,格式: 工具名(参数模式),支持glob通配符

agentIdintegerrequired

智能体ID

priorityintegernullable

优先级,数字越小优先级越高

descriptionstringnullable

规则用途说明

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/security/permission/deleteRule

删除权限规则

根据规则ID删除权限规则(软删除)

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

idintegerrequired

规则ID

agentIdintegerrequired

智能体ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/security/permission/generateRule

智能生成权限规则

输入自然语言描述,异步提交AI生成任务,返回请求ID用于轮询结果

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

descriptionstringrequired

自然语言描述,例如: '禁止删除文件'、'转账操作需要人工确认'

agentIdintegerrequired

智能体ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

datastringnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/security/permission/pollGenerateRule

轮询权限规则生成结果

通过请求ID轮询AI生成的权限规则结果,status为PROCESSING时继续轮询

请求参数

Query 参数1 个字段

requestIdstringrequired

生成任务的请求ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/security/permission/listTemplates

获取权限模板列表

获取平台预置的所有权限模板

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/security/permission/getTemplateDetail

获取权限模板详情

获取指定权限模板的详细信息及其包含的规则列表

请求参数

Query 参数1 个字段

templateIdintegerrequired

模板ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/security/permission/applyTemplate

应用权限模板

将权限模板中的规则批量应用到指定智能体,已存在的相同规则会自动跳过

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

templateIdintegerrequired

权限模板ID

agentIdintegerrequired

智能体ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理