Chapter 2. ClusterRoleBinding [rbac.authorization.k8s.io/v1]

Description

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

Type

object

Required

roleRef

2.1. Specification

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata.
`roleRef`	`object`	RoleRef contains information that points to the role being used
`subjects`	`array`	Subjects holds references to the objects the role applies to.
`subjects[]`	`object`	Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

2.1.1. .roleRef

Description

RoleRef contains information that points to the role being used

Type

object

Required

apiGroup
kind
name

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced
`kind`	`string`	Kind is the type of resource being referenced
`name`	`string`	Name is the name of resource being referenced

2.1.2. .subjects

Description: Subjects holds references to the objects the role applies to.
Type: array

2.1.3. .subjects[]

Description

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

Type

object

Required

kind
name

Property	Type	Description
`apiGroup`	`string`	APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
`kind`	`string`	Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
`name`	`string`	Name of the object being referenced.
`namespace`	`string`	Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

2.2. API endpoints

The following API endpoints are available:

/apis/rbac.authorization.k8s.io/v1/clusterrolebindings
- DELETE: delete collection of ClusterRoleBinding
- GET: list or watch objects of kind ClusterRoleBinding
- POST: create a ClusterRoleBinding
/apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
- GET: watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
/apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
- DELETE: delete a ClusterRoleBinding
- GET: read the specified ClusterRoleBinding
- PATCH: partially update the specified ClusterRoleBinding
- PUT: replace the specified ClusterRoleBinding
/apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
- GET: watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

2.2.1. /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

HTTP method: DELETE
Description: delete collection of ClusterRoleBinding

Table 2.1. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 2.2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list or watch objects of kind ClusterRoleBinding

Table 2.3. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBindingList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterRoleBinding

Table 2.4. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 2.5. Body parameters
Parameter	Type	Description
`body`	`ClusterRoleBinding` schema

Table 2.6. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding` schema
201 - Created	`ClusterRoleBinding` schema
202 - Accepted	`ClusterRoleBinding` schema
401 - Unauthorized	Empty

2.2.2. /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings

HTTP method: GET
Description: watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

Table 2.7. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

2.2.3. /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

Table 2.8. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterRoleBinding

HTTP method: DELETE
Description: delete a ClusterRoleBinding

Table 2.9. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 2.10. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ClusterRoleBinding

Table 2.11. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ClusterRoleBinding

Table 2.12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 2.13. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding` schema
201 - Created	`ClusterRoleBinding` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ClusterRoleBinding

Table 2.14. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 2.15. Body parameters
Parameter	Type	Description
`body`	`ClusterRoleBinding` schema

Table 2.16. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding` schema
201 - Created	`ClusterRoleBinding` schema
401 - Unauthorized	Empty

2.2.4. /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}

Table 2.17. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterRoleBinding

HTTP method: GET
Description: watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

Table 2.18. HTTP responses
HTTP code	Reponse body
200 - OK	`WatchEvent` schema
401 - Unauthorized	Empty

Chapter 2. ClusterRoleBinding [rbac.authorization.k8s.io/v1]

2.1. Specification

2.1.1. .roleRef

2.1.2. .subjects

2.1.3. .subjects[]

2.2. API endpoints

2.2.1. /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

2.2.2. /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings

2.2.3. /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}

2.2.4. /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links