完整文档索引见 llms.txt。在页面 URL 后附加
.md即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。
凭据类型策略
预览阶段,即使不提升主版本号,也可能出现破坏性变更。
预览:获取实例的凭据类型策略
**预览**——即使不提升主版本号,也可能出现破坏性变更。
返回组合后的实例作用域策略,包括默认动作,以及按评估顺序排列的所有已附加策略文档中的规则。从未配置过的实例会返回 `scopeId: null`、空规则、`defaultAction: allow` 和 `version: 0`。
/credential-type-policies/instance响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
401 | 未授权 |
403 | 禁止访问 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scopeId | string | 是 | |||||||||||||||||
rules | array | 是 | 展开字段
| ||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||
version | integer | 是 |
预览:替换实例的凭据类型策略
**预览**——即使不提升主版本号,也可能出现破坏性变更。
设置实例的默认动作,并替换其单个策略文档中的规则;首次写入时会创建二者。`version` 必须等于上次读取的版本,过期值会以 409 拒绝。规则 ID 在列表内必须唯一。
/credential-type-policies/instance请求体
application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rules | array | 是 | 展开字段
| ||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||
version | integer | 是 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
409 | 冲突 |
415 | 不支持的媒体类型。 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scopeId | string | 是 | |||||||||||||||||||||||||||||
rules | array | 是 | 展开字段
| ||||||||||||||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||||||||||||||
version | integer | 是 | |||||||||||||||||||||||||||||
warnings | array | 是 | 展开字段结构 1
结构 2
|
预览:获取项目的凭据类型策略
**预览**——即使不提升主版本号,也可能出现破坏性变更。
返回项目自身组合后的策略,不是与实例策略合并后的结果。从未配置过的项目会返回 `scopeId: null`、空规则、`defaultAction: allow` 和 `version: 0`。
/credential-type-policies/projects/{projectId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
projectId | path | string | 是 | 项目的 ID。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
401 | 未授权 |
403 | 禁止访问 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scopeId | string | 是 | |||||||||||||||||
rules | array | 是 | 展开字段
| ||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||
version | integer | 是 |
预览:替换项目的凭据类型策略
**预览**——即使不提升主版本号,也可能出现破坏性变更。
设置项目的默认动作,并替换其单个策略文档中的规则;首次写入时会创建二者。项目作用域不接受 `delegate` 动作。`version` 必须等于上次读取的版本;过期值会以 409 拒绝,与其他作用域共享的项目策略文档也会被拒绝。
/credential-type-policies/projects/{projectId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
projectId | path | string | 是 | 项目的 ID。 |
请求体
application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rules | array | 是 | 展开字段
| ||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||
version | integer | 是 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
409 | 冲突 |
415 | 不支持的媒体类型。 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scopeId | string | 是 | |||||||||||||||||||||||||||||
rules | array | 是 | 展开字段
| ||||||||||||||||||||||||||||
defaultAction | string | 是 | 可选值: | ||||||||||||||||||||||||||||
version | integer | 是 | |||||||||||||||||||||||||||||
warnings | array | 是 | 展开字段结构 1
结构 2
|
预览:列出凭据类型策略文档
**预览**——即使不提升主版本号,也可能出现破坏性变更。
返回可复用策略文档的游标分页列表。
/credential-type-policies/policies请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
limit | query | number | 否 | 最多返回的数据项数量。 默认值: |
cursor | query | string | 否 | 将 cursor 参数设为上次请求响应中的 nextCursor 属性,以进行分页。使用默认值时,获取集合的第一页。更多信息,请参阅分页说明。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | array | 是 | 展开字段
| ||||||||||||||||||||||||||||||||
nextCursor | string | 是 |
预览:创建凭据类型策略文档
**预览**——即使不提升主版本号,也可能出现破坏性变更。
创建尚未附加到任何作用域的可复用策略文档。规则 ID 在列表内必须唯一。`warnings` 列出已被前面规则覆盖的规则。
/credential-type-policies/policies请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
Idempotency-Key | header | string | 否 | 此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。 |
请求体
application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
rules | array | 是 | 展开字段
|
响应
| 状态码 | 说明 |
|---|---|
201 | 操作成功。 |
400 | 请求无效,或提供的数据格式错误。 |
401 | 未授权 |
403 | 禁止访问 |
409 | 冲突 |
415 | 不支持的媒体类型。 |
422 | 无法处理的实体 |
503 | 所请求的服务暂时不可用。 |
响应结构:201 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policy | object | 是 | 展开字段
| ||||||||||||||||||||||||||||||||||||||||||||||||
warnings | array | 是 | 展开字段结构 1
结构 2
|
预览:获取凭据类型策略文档
**预览**——即使不提升主版本号,也可能出现破坏性变更。
/credential-type-policies/policies/{policyId}请求参数
| 参数 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
policyId | path | string | 是 | 凭据类型策略文档的 ID。 |
响应
| 状态码 | 说明 |
|---|---|
200 | 操作成功。 |
401 | 未授权 |
403 | 禁止访问 |
404 | 未找到指定资源。 |
503 | 所请求的服务暂时不可用。 |
响应结构:200 · application/json
| 字段 | 类型 | 必填 | 说明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | 是 | |||||||||||||||||
kind | string | 是 | |||||||||||||||||
rules | array | 是 | 展开字段
| ||||||||||||||||
version | integer | 是 | |||||||||||||||||
updatedBy | string | 是 | |||||||||||||||||
createdAt | string | 是 | |||||||||||||||||
updatedAt | string | 是 |