用户 [user.openshift.io/v1] - 用户和组 API | API 参考 | OpenShift Container Platform 4.17

规格
API 端点

描述

登录后，系统每个用户都会收到一个用户和身份资源。管理员可以直接操作用户的属性以进行自己的跟踪，或通过 API 设置组。用户名是唯一的，并根据身份提供程序提供的值选择 - 如果已经存在具有传入名称的用户，则用户名可能会附加一个数字，具体取决于系统的配置。

兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

组

规格

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`fullName`	`字符串`	FullName 是用户的全名
`组`	`数组（字符串）`	Groups 指定此用户所属的组名称。此字段已弃用，将在未来的版本中删除。请改用创建包含此用户名称的 Group 对象。
`identities`	`数组（字符串）`	Identities 是与此用户关联的身份
`kind`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式大小写。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta_v2`	metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

fullName

字符串

FullName 是用户的全名

组

数组（字符串）

Groups 指定此用户所属的组名称。此字段已弃用，将在未来的版本中删除。请改用创建包含此用户名称的 Group 对象。

identities

数组（字符串）

Identities 是与此用户关联的身份

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式大小写。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

API 端点

提供以下 API 端点

/apis/user.openshift.io/v1/users
- DELETE：删除 User 集合
- GET：列出或监视 User 类型的对象
- POST：创建 User
/apis/user.openshift.io/v1/watch/users
- GET：监视 User 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/apis/user.openshift.io/v1/users/{name}
- DELETE：删除 User
- GET：读取指定的 User
- PATCH：部分更新指定的 User
- PUT：替换指定的 User
/apis/user.openshift.io/v1/watch/users/{name}
- GET：监视 User 类型对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/user.openshift.io/v1/users

HTTP 方法: DELETE
描述: 删除 User 集合

表 1. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status_v11` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出或监视 User 类型的对象

表 3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建 User

表 4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中丢弃，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 正文参数
参数	类型	描述
`body`	`User` 模式

表 6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - 已创建	`User` 模式
202 - 已接受	`User` 模式
401 - 未授权	空

/apis/user.openshift.io/v1/watch/users

HTTP 方法: GET
描述: 监视 User 列表的单个更改。已弃用：改为使用列表操作中的“watch”参数。

表 7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空

/apis/user.openshift.io/v1/users/{name}

表 8. 全局路径参数
参数	类型	描述
`name`	`字符串`	User 的名称

HTTP 方法: DELETE
描述: 删除 User

表 9. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status_v11` 模式
202 - 已接受	`Status_v11` 模式
401 - 未授权	空

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

表 11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
401 - 未授权	空

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

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中丢弃，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - 已创建	`User` 模式
401 - 未授权	空

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

表 14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：对于对象中被丢弃的每个未知字段和遇到的每个重复字段，这将通过标准警告响应头发送警告。如果没有任何其他错误，请求仍然会成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值。- Strict：如果任何未知字段将被从对象中丢弃，或者存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 15. 正文参数
参数	类型	描述
`body`	`User` 模式

表 16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - 已创建	`User` 模式
401 - 未授权	空

/apis/user.openshift.io/v1/watch/users/{name}

表 17. 全局路径参数
参数	类型	描述
`name`	`字符串`	User 的名称

HTTP 方法: GET
描述: 监视 User 类型对象的更改。已弃用：改为使用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

表 18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - 未授权	空