用户和组群 API

第 1 章用户和组群 API

1.1. Group [user.openshift.io/v1]

描述

group 表示一组参考的用户

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

1.2. Identity [user.openshift.io/v1]

描述

身份记录了具有身份提供程序的用户的身份验证成功。有关身份验证源的信息存储在身份上，身份与单个用户对象关联。多个身份可以引用单个用户。从身份验证提供程序检索的信息存储在额外字段中，使用由提供程序决定的 schema。

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

1.3. UserIdentityMapping [user.openshift.io/v1]

描述

UserIdentityMapping 将用户映射到身份

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

1.4. User [user.openshift.io/v1]

描述

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

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

第 2 章 Group [user.openshift.io/v1]

描述

group 表示一组参考的用户

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

users

2.1. 规格

属性	类型	描述
`apiVersion`	`string`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`users`	`数组（字符串）`	users 是此组中的用户列表。

2.2. API 端点

可用的 API 端点如下：

/apis/user.openshift.io/v1/groups
- DELETE ：删除组的集合
- GET: 列出或监视类型为 Group 的对象
- POST ：创建一个组
/apis/user.openshift.io/v1/watch/groups
- GET: 观察单个对 Group 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
/apis/user.openshift.io/v1/groups/{name}
- DELETE ：删除组
- GET ：读取指定的组
- PATCH: 部分更新指定的组
- PUT ：替换指定的组
/apis/user.openshift.io/v1/watch/groups/{name}
- GET: 观察对类型为 Group 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

2.2.1. /apis/user.openshift.io/v1/groups

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

表 2.1. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 2.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Grouplist` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建一个组

表 2.4. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 2.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Group` 模式
201 - Created	`Group` 模式
202 - Accepted	`Group` 模式
401 - Unauthorized	空

2.2.2. /apis/user.openshift.io/v1/watch/groups

HTTP 方法: GET
描述: 观察单个对 Group 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。

表 2.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

2.2.3. /apis/user.openshift.io/v1/groups/{name}

表 2.8. 全局路径参数
参数	类型	描述
`name`	`string`	组名称

HTTP 方法: DELETE
描述: 删除组

表 2.9. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 2.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Group` 模式
401 - Unauthorized	空

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

表 2.12. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Group` 模式
201 - Created	`Group` 模式
401 - Unauthorized	空

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

表 2.14. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 2.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Group` 模式
201 - Created	`Group` 模式
401 - Unauthorized	空

2.2.4. /apis/user.openshift.io/v1/watch/groups/{name}

表 2.17. 全局路径参数
参数	类型	描述
`name`	`string`	组名称

HTTP 方法: GET
描述: 观察对类型为 Group 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 2.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

第 3 章 Identity [user.openshift.io/v1]

描述

身份记录了具有身份提供程序的用户的身份验证成功。有关身份验证源的信息存储在身份上，身份与单个用户对象关联。多个身份可以引用单个用户。从身份验证提供程序检索的信息存储在额外字段中，使用由提供程序决定的 schema。

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

providerName
providerUserName
user

3.1. 规格

属性	类型	描述
`apiVersion`	`string`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`extra`	`对象（字符串）`	包含有关此身份的额外信息
`kind`	`string`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`providerName`	`string`	providerName 是身份信息的来源
`providerUserName`	`string`	providerUserName 在供应商范围内唯一代表这个身份
`user`	`ObjectReference`	user 是对此身份关联的用户的引用，并且必须设置 UID

3.2. API 端点

可用的 API 端点如下：

/apis/user.openshift.io/v1/identities
- DELETE ：删除身份的集合
- GET: 列出或监视类型身份的对象
- POST ：创建身份
/apis/user.openshift.io/v1/watch/identities
- GET: 观察单个对身份列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
/apis/user.openshift.io/v1/identities/{name}
- DELETE ：删除身份
- GET ：读取指定的身份
- PATCH: 部分更新指定的身份
- PUT ：替换指定的身份
/apis/user.openshift.io/v1/watch/identities/{name}
- GET: 观察对类型为 Identity 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。

3.2.1. /apis/user.openshift.io/v1/identities

HTTP 方法: DELETE
描述: 删除身份集合

表 3.1. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 3.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`IdentityList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建身份

表 3.4. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 3.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Identity` 模式
201 - Created	`Identity` 模式
202 - Accepted	`Identity` 模式
401 - Unauthorized	空

3.2.2. /apis/user.openshift.io/v1/watch/identities

HTTP 方法: GET
描述: 观察单个对 Identity. 弃用的更改。已弃用：改为使用 'watch' 参数及列表操作。

表 3.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

3.2.3. /apis/user.openshift.io/v1/identities/{name}

表 3.8. 全局路径参数
参数	类型	描述
`name`	`string`	身份的名称

HTTP 方法: DELETE
描述: 删除身份

表 3.9. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 3.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Identity` 模式
401 - Unauthorized	空

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

表 3.12. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Identity` 模式
201 - Created	`Identity` 模式
401 - Unauthorized	空

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

表 3.14. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 3.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Identity` 模式
201 - Created	`Identity` 模式
401 - Unauthorized	空

3.2.4. /apis/user.openshift.io/v1/watch/identities/{name}

表 3.17. 全局路径参数
参数	类型	描述
`name`	`string`	身份的名称

HTTP 方法: GET
描述: 观察对类型为 Identity 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 3.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

第 4 章 UserIdentityMapping [user.openshift.io/v1]

描述

UserIdentityMapping 将用户映射到身份

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

4.1. 规格

属性	类型	描述
`apiVersion`	`string`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`identity`	`ObjectReference`	身份是对身份的引用
`kind`	`string`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`user`	`ObjectReference`	用户是对用户的引用

4.2. API 端点

可用的 API 端点如下：

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

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

表 4.1. 全局查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

HTTP 方法: POST
描述: 创建一个 UserIdentityMapping

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

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

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

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

HTTP 方法: DELETE
描述: 删除一个 UserIdentityMapping

表 4.5. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 4.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` 模式
401 - Unauthorized	空

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

表 4.8. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`UserIdentityMapping` 模式
201 - Created	`UserIdentityMapping` 模式
401 - Unauthorized	空

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

表 4.10. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

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

第 5 章 User [user.openshift.io/v1]

描述

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

兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

groups

5.1. 规格

属性	类型	描述
`apiVersion`	`string`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`fullName`	`string`	fullName 是 user 的全名
`groups`	`数组（字符串）`	组指定此用户所属的组名称。此字段已弃用，并将在以后的发行版本中删除。相反，创建一个包含此用户名称的 Group 对象。
`identities`	`数组（字符串）`	身份是与此用户关联的身份
`kind`	`string`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	metadata 是标准对象的元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

5.2. API 端点

可用的 API 端点如下：

/apis/user.openshift.io/v1/users
- DELETE ：删除用户集合
- GET ：列出或监视类型为 User 的对象
- POST ：创建用户
/apis/user.openshift.io/v1/watch/users
- GET: 观察单个对 User 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
/apis/user.openshift.io/v1/users/{name}
- DELETE ：删除用户
- GET ：读取指定用户
- PATCH: 部分更新指定用户
- PUT ：替换指定的用户
/apis/user.openshift.io/v1/watch/users/{name}
- GET: 观察对类型为 User 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。

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

HTTP 方法: DELETE
描述: 删除用户集合

表 5.1. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

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

表 5.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Userlist` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建用户

表 5.4. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 5.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - Created	`User` 模式
202 - Accepted	`User` 模式
401 - Unauthorized	空

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

HTTP 方法: GET
描述: 观察单个对用户列表的更改。已弃用：改为使用 'watch' 参数及列表操作。

表 5.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

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

表 5.8. 全局路径参数
参数	类型	描述
`name`	`string`	用户名称

HTTP 方法: DELETE
描述: 删除用户

表 5.9. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

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

HTTP 方法: GET
描述: 读取指定用户

表 5.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定用户

表 5.12. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - Created	`User` 模式
401 - Unauthorized	空

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

表 5.14. 查询参数
参数	类型	描述
`dryRun`	`string`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

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

表 5.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`User` 模式
201 - Created	`User` 模式
401 - Unauthorized	空

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

表 5.17. 全局路径参数
参数	类型	描述
`name`	`string`	用户名称

HTTP 方法: GET
描述: 观察对类型为 User 的对象的更改。已弃用：使用带列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 5.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空