ClusterRole
apiVersion: rbac.authorization.k8s.io/v1
import "k8s.io/api/rbac/v1"
ClusterRole
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
-
apiVersion: rbac.authorization.k8s.io/v1
-
kind: ClusterRole
-
metadata (
Standard object's metadata.
-
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.
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
-
rules ([]PolicyRule)
Rules holds all the PolicyRules for this ClusterRole
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.apiGroups ([]string)
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
-
rules.resources ([]string)
Resources is a list of resources this rule applies to. '*' represents all resources.
-
rules.verbs ([]string), required
Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
-
rules.resourceNames ([]string)
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
-
rules.nonResourceURLs ([]string)
NonResourceURLs 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 Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
-
ClusterRoleList
ClusterRoleList is a collection of ClusterRoles
-
apiVersion: rbac.authorization.k8s.io/v1
-
kind: ClusterRoleList
-
metadata (
Standard object's metadata.
-
items ([]
Items is a list of ClusterRoles
Operations
get
read the specified ClusterRole
HTTP Request
GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
Parameters
Response
200 (
401: Unauthorized GET /apis/rbac.authorization.k8s.io/v1/clusterroles allowWatchBookmarks (in query): boolean continue (in query): string fieldSelector (in query): string labelSelector (in query): string limit (in query): integer pretty (in query): string resourceVersion (in query): string resourceVersionMatch (in query): string timeoutSeconds (in query): integer watch (in query): boolean 200 (
401: Unauthorized POST /apis/rbac.authorization.k8s.io/v1/clusterroles dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
202 (
401: Unauthorized PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} name (in path): string, required name of the ClusterRole dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string pretty (in query): string 200 (
201 (
401: Unauthorized PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} name (in path): string, required name of the ClusterRole dryRun (in query): string fieldManager (in query): string fieldValidation (in query): string force (in query): boolean pretty (in query): string 200 (
201 (
401: Unauthorized DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} name (in path): string, required name of the ClusterRole dryRun (in query): string gracePeriodSeconds (in query): integer pretty (in query): string propagationPolicy (in query): string 200 (
202 (
401: Unauthorized DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles continue (in query): string dryRun (in query): string fieldSelector (in query): string gracePeriodSeconds (in query): integer labelSelector (in query): string limit (in query): integer pretty (in query): string propagationPolicy (in query): string resourceVersion (in query): string resourceVersionMatch (in query): string timeoutSeconds (in query): integer 200 (
401: Unauthorizedlist
list or watch objects of kind ClusterRoleHTTP Request
Parameters
Response
create
create a ClusterRoleHTTP Request
Parameters
Response
update
replace the specified ClusterRoleHTTP Request
Parameters
Response
patch
partially update the specified ClusterRoleHTTP Request
Parameters
Response
delete
delete a ClusterRoleHTTP Request
Parameters
Response
deletecollection
delete collection of ClusterRoleHTTP Request
Parameters
Response