查看 Markdown
POST/api/principal/create

创建身份主体

在当前应用下创建一个新的身份主体,每个主体拥有独立的对话上下文。创建主体不会自动开通存储空间;需要时可主动开通或创建项目。

请求参数

请求体(JSON)2 个字段

principalNamestringrequired

主体名称,用于标识该身份主体

principalDescriptionstringnullable

主体描述,选填

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

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

errCodestringnullable

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

查看 Markdown
POST/api/principal/update

修改身份主体

修改当前应用下指定身份主体的名称和描述,名称会同步更新到点金内核;不允许修改系统内置主体

请求参数

请求体(JSON)3 个字段

principalIdintegerrequired

要修改的身份主体ID

principalNamestringrequired

主体名称,用于标识该身份主体,会同步更新到点金内核

principalDescriptionstringnullable

主体描述,选填,仅在控制台本地维护

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

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

errCodestringnullable

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

查看 Markdown
GET/api/principal/list

查询身份主体列表

分页查询当前应用下的所有身份主体,支持按名称模糊搜索

请求参数

Query 参数3 个字段

pageNumintegernullable

页码,从1开始,默认1

pageSizeintegernullable

每页大小,默认20

principalNamestringnullable

主体名称,支持模糊搜索

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

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

errCodestringnullable

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

查看 Markdown
DELETE/api/principal/delete

删除身份主体

软删除当前应用下指定的身份主体

请求参数

Query 参数1 个字段

principalIdintegerrequired

要删除的身份主体ID,必填

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

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

errCodestringnullable

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