完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

角色映射规则

身份提供方角色映射规则相关操作

获取角色映射规则

返回已配置的角色映射规则。`order` 是规则在自身 `type` 内的评估位置，因此实例规则和项目规则各自拥有从 0 开始的序列。按 `type` 筛选，可获取单一类型的评估顺序。

GET/role-mapping-rules

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
type	query	string	否	可选值：instance, project

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]expression string 是 data.[]role string 是 data.[]type string 是 可选值：instance, project data.[]order integer 是 data.[]projectIds array 是 data.[]createdAt string 是 data.[]updatedAt string 是
nextCursor	string	是

下载完整 OpenAPI 定义（JSON）

创建角色映射规则

创建将身份提供方声明表达式映射到角色的规则。将 `type` 设为 `instance` 时授予全局角色，设为 `project` 时在 `projectIds` 指定的项目中授予项目角色。省略 `order` 时，会将规则追加到同类型评估顺序的末尾。

POST/role-mapping-rules

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	否
projectIds	array	否

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：201 · application/json

字段	类型	必填	说明
id	string	是
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	是
projectIds	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

移动角色映射规则

更改规则在同类型评估顺序中的位置。`targetIndex` 是规则自身 `type` 序列中以 0 为起点的目标位置；超过最后位置的值会将规则移到末尾。

POST/role-mapping-rules/{roleMappingRuleId}/move

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。
roleMappingRuleId	path	string	是	角色映射规则的 ID。

请求体

application/json

字段	类型	必填	说明
targetIndex	integer	是

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	是
projectIds	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

删除角色映射规则

删除角色映射规则。同类型的其余规则会补齐空位，使 `order` 值继续保持从 0 开始的连续序列。

DELETE/role-mapping-rules/{roleMappingRuleId}

请求参数

参数	位置	类型	必填	说明
roleMappingRuleId	path	string	是	角色映射规则的 ID。

响应

状态码	说明
200	操作成功。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	是
projectIds	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）

更新角色映射规则

更新规则的声明表达式、角色和／或项目分配。规则类型在创建后不能更改，因此此处不接受 `type`；调整顺序需使用移动端点。

PATCH/role-mapping-rules/{roleMappingRuleId}

请求参数

参数	位置	类型	必填	说明
roleMappingRuleId	path	string	是	角色映射规则的 ID。

请求体

application/json

字段	类型	必填	说明
expression	string	否
role	string	否
projectIds	array	否

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
expression	string	是
role	string	是
type	string	是	可选值：instance, project
order	integer	是
projectIds	array	是
createdAt	string	是
updatedAt	string	是

下载完整 OpenAPI 定义（JSON）