跳到主要内容

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

凭据类型策略

预览阶段,即使不提升主版本号,也可能出现破坏性变更。

预览:获取实例的凭据类型策略 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

返回组合后的实例作用域策略,包括默认动作,以及按评估顺序排列的所有已附加策略文档中的规则。从未配置过的实例会返回 `scopeId: null`、空规则、`defaultAction: allow` 和 `version: 0`。

GET/credential-type-policies/instance

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
scopeIdstring是
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny, delegate

versioninteger是

下载完整 OpenAPI 定义(JSON)

预览:替换实例的凭据类型策略 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

设置实例的默认动作,并替换其单个策略文档中的规则;首次写入时会创建二者。`version` 必须等于上次读取的版本,过期值会以 409 拒绝。规则 ID 在列表内必须唯一。

PUT/credential-type-policies/instance

请求体

application/json

字段类型必填说明
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny, delegate

versioninteger是

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

409

冲突

415

不支持的媒体类型。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
scopeIdstring是
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny, delegate

versioninteger是
warningsarray是
展开字段

结构 1

字段类型必填说明
warnings.[]kindstring是

可选值:shadowed

warnings.[]ruleIdstring是
warnings.[]shadowedByRuleIdstring是

结构 2

字段类型必填说明
warnings.[]kindstring是

可选值:notLoaded

warnings.[]ruleIdstring是

下载完整 OpenAPI 定义(JSON)

预览:获取项目的凭据类型策略 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

返回项目自身组合后的策略,不是与实例策略合并后的结果。从未配置过的项目会返回 `scopeId: null`、空规则、`defaultAction: allow` 和 `version: 0`。

GET/credential-type-policies/projects/{projectId}

请求参数

参数位置类型必填说明
projectIdpathstring是

项目的 ID。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
scopeIdstring是
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny, delegate

versioninteger是

下载完整 OpenAPI 定义(JSON)

预览:替换项目的凭据类型策略 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

设置项目的默认动作,并替换其单个策略文档中的规则;首次写入时会创建二者。项目作用域不接受 `delegate` 动作。`version` 必须等于上次读取的版本;过期值会以 409 拒绝,与其他作用域共享的项目策略文档也会被拒绝。

PUT/credential-type-policies/projects/{projectId}

请求参数

参数位置类型必填说明
projectIdpathstring是

项目的 ID。

请求体

application/json

字段类型必填说明
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny

versioninteger是

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

409

冲突

415

不支持的媒体类型。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
scopeIdstring是
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

defaultActionstring是

可选值:allow, deny, delegate

versioninteger是
warningsarray是
展开字段

结构 1

字段类型必填说明
warnings.[]kindstring是

可选值:shadowed

warnings.[]ruleIdstring是
warnings.[]shadowedByRuleIdstring是

结构 2

字段类型必填说明
warnings.[]kindstring是

可选值:notLoaded

warnings.[]ruleIdstring是

下载完整 OpenAPI 定义(JSON)

预览:列出凭据类型策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

返回可复用策略文档的游标分页列表。

GET/credential-type-policies/policies

请求参数

参数位置类型必填说明
limitquerynumber否

最多返回的数据项数量。

默认值:100

cursorquerystring否

将 cursor 参数设为上次请求响应中的 nextCursor 属性,以进行分页。使用默认值时,获取集合的第一页。更多信息,请参阅分页说明。

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
dataarray是
展开字段
字段类型必填说明
data.[]idstring是
data.[]kindstring是
data.[]rulesarray是
data.[]versioninteger是
data.[]updatedBystring是
data.[]createdAtstring是
data.[]updatedAtstring是
nextCursorstring是

下载完整 OpenAPI 定义(JSON)

预览:创建凭据类型策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

创建尚未附加到任何作用域的可复用策略文档。规则 ID 在列表内必须唯一。`warnings` 列出已被前面规则覆盖的规则。

POST/credential-type-policies/policies

请求参数

参数位置类型必填说明
Idempotency-Keyheaderstring否

此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。

请求体

application/json

字段类型必填说明
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

响应

状态码说明
201

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

409

冲突

415

不支持的媒体类型。

422

无法处理的实体

503

所请求的服务暂时不可用。

响应结构:201 · application/json
字段类型必填说明
policyobject是
展开字段
字段类型必填说明
policy.idstring是
policy.kindstring是
policy.rulesarray是
展开字段
字段类型必填说明
policy.rules.[]idstring是
policy.rules.[]actionstring是

可选值:allow, deny, delegate

policy.rules.[]selectorobject是
policy.versioninteger是
policy.updatedBystring是
policy.createdAtstring是
policy.updatedAtstring是
warningsarray是
展开字段

结构 1

字段类型必填说明
warnings.[]kindstring是

可选值:shadowed

warnings.[]ruleIdstring是
warnings.[]shadowedByRuleIdstring是

结构 2

字段类型必填说明
warnings.[]kindstring是

可选值:notLoaded

warnings.[]ruleIdstring是

下载完整 OpenAPI 定义(JSON)

预览:获取凭据类型策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

GET/credential-type-policies/policies/{policyId}

请求参数

参数位置类型必填说明
policyIdpathstring是

凭据类型策略文档的 ID。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
idstring是
kindstring是
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

versioninteger是
updatedBystring是
createdAtstring是
updatedAtstring是

下载完整 OpenAPI 定义(JSON)

预览:替换凭据类型策略文档的规则 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

替换文档的完整规则列表。`version` 必须等于上次读取的版本,过期值会以 409 拒绝。此文档所附加到的每个作用域,其版本都会递增。文档附加到项目作用域时,`delegate` 规则会被拒绝。

PUT/credential-type-policies/policies/{policyId}

请求参数

参数位置类型必填说明
policyIdpathstring是

凭据类型策略文档的 ID。

请求体

application/json

字段类型必填说明
rulesarray是
展开字段
字段类型必填说明
rules.[]idstring是
rules.[]actionstring是

可选值:allow, deny, delegate

rules.[]selectorobject是
展开字段

结构 1

结构 2

结构 3

versioninteger是

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

415

不支持的媒体类型。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
policyobject是
展开字段
字段类型必填说明
policy.idstring是
policy.kindstring是
policy.rulesarray是
展开字段
字段类型必填说明
policy.rules.[]idstring是
policy.rules.[]actionstring是

可选值:allow, deny, delegate

policy.rules.[]selectorobject是
policy.versioninteger是
policy.updatedBystring是
policy.createdAtstring是
policy.updatedAtstring是
warningsarray是
展开字段

结构 1

字段类型必填说明
warnings.[]kindstring是

可选值:shadowed

warnings.[]ruleIdstring是
warnings.[]shadowedByRuleIdstring是

结构 2

字段类型必填说明
warnings.[]kindstring是

可选值:notLoaded

warnings.[]ruleIdstring是

下载完整 OpenAPI 定义(JSON)

预览:删除凭据类型策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

删除策略文档。如果文档仍附加在某个作用域上,会以 409 拒绝;请先解除附加关系。

DELETE/credential-type-policies/policies/{policyId}

请求参数

参数位置类型必填说明
policyIdpathstring是

凭据类型策略文档的 ID。

响应

状态码说明
204

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

503

所请求的服务暂时不可用。

下载完整 OpenAPI 定义(JSON)

预览:获取作用域附加的策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

返回所有已附加的策略文档和作用域版本。附加文档按评估顺序排列:先处理 floor 组,再在各组内按优先级升序排列。替换附加关系时使用此版本。`scopeId` 来自 `GET /instance` 或 `GET /projects/{projectId}`;作用域首次写入之前为 null。即使针对项目作用域,此路由也需要实例级访问权限。

GET/credential-type-policies/scopes/{scopeId}/attachments

请求参数

参数位置类型必填说明
scopeIdpathstring是

凭据类型策略作用域的 ID。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
attachmentsarray是
展开字段
字段类型必填说明
attachments.[]policyIdstring是
attachments.[]rulesarray是
attachments.[]priorityinteger是
attachments.[]isFloorboolean是
versioninteger是

下载完整 OpenAPI 定义(JSON)

预览:替换作用域附加的策略文档 ​

**预览**——即使不提升主版本号,也可能出现破坏性变更。

替换作用域上的全部附加关系。作用域已被写入后,`scopeId` 可从该作用域的 `GET` 响应中获取。每个 `policyId` 及每个 `(isFloor, priority)` 组合在列表内都必须唯一。`version` 必须与当前作用域版本匹配。过期版本返回 409,且不作任何更改。成功写入后,作用域版本递增。

PUT/credential-type-policies/scopes/{scopeId}/attachments

请求参数

参数位置类型必填说明
scopeIdpathstring是

凭据类型策略作用域的 ID。

请求体

application/json

字段类型必填说明
attachmentsarray是
展开字段
字段类型必填说明
attachments.[]policyIdstring是
attachments.[]priorityinteger是
attachments.[]isFloorboolean是
versioninteger是

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

415

不支持的媒体类型。

503

所请求的服务暂时不可用。

响应结构:200 · application/json
字段类型必填说明
attachmentsarray是
展开字段
字段类型必填说明
attachments.[]policyIdstring是
attachments.[]rulesarray是
attachments.[]priorityinteger是
attachments.[]isFloorboolean是
versioninteger是

下载完整 OpenAPI 定义(JSON)

本文为社区中文翻译。查看对应英文原文