website/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md

---

ClusterRole v1alpha1

Group	Version	Kind
RbacAuthorization	v1alpha1	ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Appears In ClusterRoleList

Field	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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ObjectMeta	Standard object's metadata.
rules PolicyRule array	Rules holds all the PolicyRules for this ClusterRole

ClusterRoleList v1alpha1

Field	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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
items ClusterRole array	Items is a list of ClusterRoles
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata ListMeta	Standard object's metadata.

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

create a ClusterRole

HTTP Request

POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body ClusterRole

Response

Code	Description
200 ClusterRole	OK

Replace

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

replace the specified ClusterRole

HTTP Request

PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

Path Parameters

Parameter	Description
name	name of the ClusterRole

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body ClusterRole

Response

Code	Description
200 ClusterRole	OK

Patch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

partially update the specified ClusterRole

HTTP Request

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

Path Parameters

Parameter	Description
name	name of the ClusterRole

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Body Parameters

Parameter	Description
body Patch

Response

Code	Description
200 ClusterRole	OK

Delete

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete a ClusterRole

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

Path Parameters

Parameter	Description
name	name of the ClusterRole

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
gracePeriodSeconds	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	Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.

Body Parameters

Parameter	Description
body DeleteOptions

Response

Code	Description
200 Status	OK

Delete Collection

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

delete collection of ClusterRole

HTTP Request

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Status	OK

Read Operations

See supported operations below...

Read

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

read the specified ClusterRole

HTTP Request

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

Path Parameters

Parameter	Description
name	name of the ClusterRole

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.

Response

Code	Description
200 ClusterRole	OK

List

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

list or watch objects of kind ClusterRole

HTTP Request

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

Query Parameters

Parameter	Description
pretty	If 'true', then the output is pretty printed.
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
resourceVersion	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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 ClusterRoleList	OK

Watch

bdocs-tab:kubectl kubectl Command

Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)

Coming Soon

bdocs-tab:kubectl Output

Coming Soon

bdocs-tab:curl Response Body

Coming Soon

watch changes to an object of kind ClusterRole

HTTP Request

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}

Path Parameters

Parameter	Description
name	name of the ClusterRole

Query Parameters

Parameter	Description
fieldSelector	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	A selector to restrict the list of returned objects by their labels. Defaults to everything.
pretty	If 'true', then the output is pretty printed.
resourceVersion	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.
timeoutSeconds	Timeout for the list/watch call.
watch	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

Code	Description
200 Event	OK