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

规格
API 端点

描述

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

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

类型

对象

必需

主体
roleRef

规格

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`groupNames`	`数组（字符串）`	GroupNames 包含直接绑定到角色的所有组。此字段仅在支持旧版客户端和服务器时才应指定。有关详细信息，请参阅主题。
`种类`	`字符串`	Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。采用驼峰式大小写。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`元数据`	`ObjectMeta_v2`	元数据是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`roleRef`	`对象引用`	RoleRef 只能引用当前命名空间和全局命名空间。如果无法解析 RoleRef，则授权者必须返回错误。由于策略是单例，因此这足以找到角色。
`主体`	`数组（对象引用）`	主体持有对象引用以授权此规则。如果指定了 UserNames 或 GroupNames 以支持旧版客户端和服务器，则忽略此字段。因此，不需要支持向后兼容性的较新客户端应该只发送完全限定的主体，并且应该省略 UserNames 和 GroupNames 字段。需要支持向后兼容性的客户端可以使用此字段来构建 UserNames 和 GroupNames。
`userNames`	`数组（字符串）`	UserNames 包含直接绑定到角色的所有用户名。仅在支持旧版客户端和服务器时才应指定此字段。有关详细信息，请参阅主体。

apiVersion

字符串

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

groupNames

数组（字符串）

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

种类

字符串

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

元数据

ObjectMeta_v2

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

roleRef

对象引用

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

主体

数组（对象引用）

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

userNames

数组（字符串）

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

API 端点

提供以下 API 端点：

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

/apis/authorization.openshift.io/v1/rolebindings

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

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

/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings

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

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

HTTP 方法: POST
描述: 创建 RoleBinding

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

表 4. 请求体参数
参数	类型	描述
`body`	`RoleBinding` 模式

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

/apis/authorization.openshift.io/v1/namespaces/{namespace}/rolebindings/{name}

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

HTTP 方法: DELETE
描述: 删除 RoleBinding

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

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

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

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

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

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

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

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

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

表 13. 请求体参数
参数	类型	描述
`body`	`RoleBinding` 模式

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