4.2. API 端点

可用的 API 端点如下：

/apis/user.openshift.io/v1/useridentitymappings
- POST ：创建一个 UserIdentityMapping
/apis/user.openshift.io/v1/useridentitymappings/{name}
- DELETE: delete an UserIdentityMapping
- GET ：读取指定的 UserIdentityMapping
- PATCH: 部分更新指定的 UserIdentityMapping
- PUT ：替换指定的 UserIdentityMapping

4.2.1. /apis/user.openshift.io/v1/useridentitymappings

表 4.1. 全局查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: POST
描述: create an UserIdentityMapping

表 4.2. 主体参数
参数	类型	描述
`正文（body）`	`UserIdentityMapping` schema

表 4.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` schema
201 - Created	`UserIdentityMapping` schema
202 - Accepted	`UserIdentityMapping` schema
401 - Unauthorized	空

4.2.2. /apis/user.openshift.io/v1/useridentitymappings/{name}

表 4.4. 全局路径参数
参数	类型	描述
`name`	`string`	UserIdentityMapping 的名称

表 4.5. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: delete an UserIdentityMapping

表 4.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

表 4.7. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

表 4.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 UserIdentityMapping

表 4.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 UserIdentityMapping

表 4.10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对非应用补丁类型(JsonPatch、MergePatch、MergePatch)是可选的。
`force`	`布尔值`	强制要"强制"应用请求。这意味着用户将重新分配由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

表 4.11. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

表 4.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` schema
201 - Created	`UserIdentityMapping` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 UserIdentityMapping

表 4.13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

表 4.14. 主体参数
参数	类型	描述
`正文（body）`	`UserIdentityMapping` schema

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` schema
201 - Created	`UserIdentityMapping` schema
401 - Unauthorized	空

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

© 2024 Red Hat, Inc.