// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="clusterrole-authorization-openshift-io-v1"]
= ClusterRole [authorization.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--

Type::
  `object`

Required::
  - `rules`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `aggregationRule`
| xref:../objects/index.adoc#io-k8s-api-rbac-v1-AggregationRule[`AggregationRule`]
| aggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.

| `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`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `rules`
| `array`
| rules holds all the PolicyRules for this ClusterRole

| `rules[]`
| `object`
| PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

|===
=== .rules
Description::
+
--
rules holds all the PolicyRules for this ClusterRole
--

Type::
  `array`




=== .rules[]
Description::
+
--
PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.
--

Type::
  `object`

Required::
  - `verbs`
  - `resources`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroups`
| `array (string)`
| apiGroups is the name of the APIGroup that contains the resources.  If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed

| `attributeRestrictions`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-runtime-RawExtension[`RawExtension`]
| attributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

| `nonResourceURLs`
| `array (string)`
| NonResourceURLsSlice is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.

| `resourceNames`
| `array (string)`
| resourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.

| `resources`
| `array (string)`
| resources is a list of resources this rule applies to.  ResourceAll represents all resources.

| `verbs`
| `array (string)`
| verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule.  VerbAll represents all kinds.

|===

== API endpoints

The following API endpoints are available:

* `/apis/authorization.openshift.io/v1/clusterroles`
- `GET`: list objects of kind ClusterRole
- `POST`: create a ClusterRole
* `/apis/authorization.openshift.io/v1/clusterroles/{name}`
- `DELETE`: delete a ClusterRole
- `GET`: read the specified ClusterRole
- `PATCH`: partially update the specified ClusterRole
- `PUT`: replace the specified ClusterRole


=== /apis/authorization.openshift.io/v1/clusterroles



HTTP method::
  `GET`

Description::
  list objects of kind ClusterRole




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#com-github-openshift-api-authorization-v1-ClusterRoleList[`ClusterRoleList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a ClusterRole


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 201 - Created
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 202 - Accepted
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/authorization.openshift.io/v1/clusterroles/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterRole
|===


HTTP method::
  `DELETE`

Description::
  delete a ClusterRole


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status_v2[`Status_v2`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status_v2[`Status_v2`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified ClusterRole


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified ClusterRole


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 201 - Created
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified ClusterRole


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 201 - Created
| xref:../role_apis/clusterrole-authorization-openshift-io-v1.adoc#clusterrole-authorization-openshift-io-v1[`ClusterRole`] schema
| 401 - Unauthorized
| Empty
|===


