集群角色绑定 [authorization.openshift.io/v1] - 角色 API | API 参考 | OpenShift Container Platform 4.17

规范
API端点
- /apis/authorization.openshift.io/v1/clusterrolebindings
- /apis/authorization.openshift.io/v1/clusterrolebindings/{name}

描述

ClusterRoleBinding引用ClusterRole，但不包含它。它可以引用同一命名空间或全局命名空间中的任何ClusterRole。它通过（用户和组）或主题和命名空间信息（它存在的命名空间）添加who信息。给定命名空间中的ClusterRoleBinding仅在该命名空间中有效（主命名空间除外，它在所有命名空间中都具有权限）。

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

类型

对象

必需

subjects
roleRef

规范

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion定义了对象的此表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`groupNames`	`数组（字符串）`	GroupNames包含直接绑定到角色的所有组。仅在支持旧版客户端和服务器时才应指定此字段。有关详细信息，请参阅主题。
`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
`roleRef`	`ObjectReference`	RoleRef只能引用当前命名空间和全局命名空间。如果无法解析ClusterRoleRef，则授权者必须返回错误。由于策略是单例，因此这足以找到角色。
`subjects`	`数组（ObjectReference）`	Subjects保存对象引用，以便使用此规则进行授权。如果指定了UserNames或GroupNames以支持旧版客户端和服务器，则忽略此字段。因此，不需要支持向后兼容性的较新客户端应该只发送完全限定的Subjects，并应省略UserNames和GroupNames字段。需要支持向后兼容性的客户端可以使用此字段来构建UserNames和GroupNames。
`userNames`	`数组（字符串）`	UserNames包含直接绑定到角色的所有用户名。仅在支持旧版客户端和服务器时才应指定此字段。有关详细信息，请参阅主题。

apiVersion

字符串

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

groupNames

数组（字符串）

GroupNames包含直接绑定到角色的所有组。仅在支持旧版客户端和服务器时才应指定此字段。有关详细信息，请参阅主题。

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

roleRef

ObjectReference

RoleRef只能引用当前命名空间和全局命名空间。如果无法解析ClusterRoleRef，则授权者必须返回错误。由于策略是单例，因此这足以找到角色。

subjects

数组（ObjectReference）

Subjects保存对象引用，以便使用此规则进行授权。如果指定了UserNames或GroupNames以支持旧版客户端和服务器，则忽略此字段。因此，不需要支持向后兼容性的较新客户端应该只发送完全限定的Subjects，并应省略UserNames和GroupNames字段。需要支持向后兼容性的客户端可以使用此字段来构建UserNames和GroupNames。

userNames

数组（字符串）

UserNames包含直接绑定到角色的所有用户名。仅在支持旧版客户端和服务器时才应指定此字段。有关详细信息，请参阅主题。

API端点

提供以下API端点

/apis/authorization.openshift.io/v1/clusterrolebindings
- GET：列出ClusterRoleBinding类型的对象
- POST：创建一个ClusterRoleBinding
/apis/authorization.openshift.io/v1/clusterrolebindings/{name}
- DELETE：删除一个ClusterRoleBinding
- GET：读取指定的ClusterRoleBinding
- PATCH：部分更新指定的ClusterRoleBinding
- PUT：替换指定的ClusterRoleBinding

/apis/authorization.openshift.io/v1/clusterrolebindings

HTTP方法: GET
描述: 列出ClusterRoleBinding类型的对象

表1. HTTP响应
HTTP代码	响应体
200 - OK	`ClusterRoleBindingList`模式
401 - 未授权	空

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

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

表 3. 请求体参数
参数	类型	描述
`body`	`ClusterRoleBinding` 模式

表 4. HTTP 响应
HTTP代码	响应体
200 - OK	`ClusterRoleBinding` 模式
201 - 已创建	`ClusterRoleBinding` 模式
202 - 已接受	`ClusterRoleBinding` 模式
401 - 未授权	空

/apis/authorization.openshift.io/v1/clusterrolebindings/{name}

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

HTTP方法: DELETE
描述: 删除 ClusterRoleBinding

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

表 7. HTTP 响应
HTTP代码	响应体
200 - OK	`Status_v3` 模式
202 - 已接受	`Status_v3` 模式
401 - 未授权	空

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

表 8. HTTP 响应
HTTP代码	响应体
200 - OK	`ClusterRoleBinding` 模式
401 - 未授权	空

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

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

表 10. HTTP 响应
HTTP代码	响应体
200 - OK	`ClusterRoleBinding` 模式
201 - 已创建	`ClusterRoleBinding` 模式
401 - 未授权	空

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

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

表 12. 请求体参数
参数	类型	描述
`body`	`ClusterRoleBinding` 模式

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

ClusterRoleBinding [authorization.openshift.io/v1]

规范

API端点

/apis/authorization.openshift.io/v1/clusterrolebindings

/apis/authorization.openshift.io/v1/clusterrolebindings/{name}