ClusterRole [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/clusterroles
- /apis/authorization.openshift.io/v1/clusterroles/{name}

Description

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

Type

object

Required

rules

Specification

Property Type Description

Property	Type	Description
`.aggregationRule`	`AggregationRule rbac.authorization.k8s.io/v1`	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/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/api-conventions.md#types-kinds
`.metadata`	`ObjectMeta meta/v1`	Standard object’s 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.

.aggregationRule

AggregationRule rbac.authorization.k8s.io/v1

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

.metadata

ObjectMeta meta/v1

Standard object’s 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
apiGroups
resources

Property Type Description

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`	`RawExtension pkg/runtime`	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.

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

RawExtension pkg/runtime

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

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 ClusterRole

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	`ClusterRoleList authorization.openshift.io/v1`
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterRole

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

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

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

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

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

HTTP method: DELETE
Description: delete a ClusterRole

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 ClusterRole

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

HTTP method: PATCH
Description: partially update the specified ClusterRole

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

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

HTTP method: PUT
Description: replace the specified ClusterRole

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

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