ClusterRoleBinding [authorization.openshift.io/v1] - authorization.openshift.io | API reference

Important

Azure Red Hat OpenShift 3.11 will be retired 30 June 2022. Support for creation of new Azure Red Hat OpenShift 3.11 clusters continues through 30 November 2020. Following retirement, remaining Azure Red Hat OpenShift 3.11 clusters will be shut down to prevent security vulnerabilities.

Follow this guide to create an Azure Red Hat OpenShift 4 cluster. If you have specific questions, please contact us

Specification
API endpoints
- /apis/authorization.openshift.io/v1/clusterrolebindings
- /apis/authorization.openshift.io/v1/clusterrolebindings/{name}

Description

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).

Type

object

Required

subjects
roleRef

Specification

Property Type Description

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/api-conventions.md#resources
`.groupNames`	`array (string)`	GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.
`.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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s metadata.
`.roleRef`	`ObjectReference core/v1`	RoleRef can only reference the current namespace and the global namespace. If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.
`.subjects`	`array (ObjectReference core/v1)`	Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.
`.userNames`	`array (string)`	UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

.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/api-conventions.md#resources

.groupNames

array (string)

GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

.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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata.

.roleRef

ObjectReference core/v1

RoleRef can only reference the current namespace and the global namespace. If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.

.subjects

array (ObjectReference core/v1)

Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.

.userNames

array (string)

UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.

API endpoints

The following API endpoints are available:

/apis/authorization.openshift.io/v1/clusterrolebindings
- GET: list objects of kind ClusterRoleBinding
- POST: create a ClusterRoleBinding
/apis/authorization.openshift.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/authorization.openshift.io/v1/clusterrolebindings

Table 1. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: list objects of kind ClusterRoleBinding

Table 2. Query parameters
Parameter	Type	Description
`continue`	`string`	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
`fieldSelector`	`string`	A selector to restrict the list of returned objects by their fields. Defaults to everything.
`includeUninitialized`	`boolean`	If true, partially initialized resources are included in the response.
`labelSelector`	`string`	A selector to restrict the list of returned objects by their labels. Defaults to everything.
`limit`	`integer`	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
`resourceVersion`	`string`	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
`timeoutSeconds`	`integer`	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
`watch`	`boolean`	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBindingList authorization.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterRoleBinding

Table 4. Body parameters
Parameter	Type	Description
`body`	`ClusterRoleBinding authorization.openshift.io/v1`

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding authorization.openshift.io/v1`
201 - Created	`ClusterRoleBinding authorization.openshift.io/v1`
202 - Accepted	`ClusterRoleBinding authorization.openshift.io/v1`
401 - Unauthorized	Empty

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

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

Table 7. Global guery parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: DELETE
Description: delete a ClusterRoleBinding

Table 8. Query parameters
Parameter	Type	Description
`gracePeriodSeconds`	`integer`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 9. Body parameters
Parameter	Type	Description
`body`	`DeleteOptions meta/v1`

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`Status meta/v1`
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ClusterRoleBinding

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding authorization.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ClusterRoleBinding

Table 12. Body parameters
Parameter	Type	Description
`body`	`Patch meta/v1`

Table 13. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding authorization.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ClusterRoleBinding

Table 14. Body parameters
Parameter	Type	Description
`body`	`ClusterRoleBinding authorization.openshift.io/v1`

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterRoleBinding authorization.openshift.io/v1`
201 - Created	`ClusterRoleBinding authorization.openshift.io/v1`
401 - Unauthorized	Empty