Role [rbac.authorization.k8s.io/v1]
- Description
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.
- Type
`object`
Specification
| 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/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 | ObjectMeta | Standard object’s metadata. |
rules | array | Rules holds all the PolicyRules for this Role |
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 Role
- 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
| Property | Type | Description |
|---|---|---|
apiGroups | array (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. "" represents the core API group and "*" represents all API groups. |
nonResourceURLs | array (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. |
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. '*' represents all resources. |
verbs | array (string) | Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. |
API endpoints
The following API endpoints are available:
/apis/rbac.authorization.k8s.io/v1/rolesGET: list or watch objects of kind Role
/apis/rbac.authorization.k8s.io/v1/watch/rolesGET: watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolesDELETE: delete collection of RoleGET: list or watch objects of kind RolePOST: create a Role
/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolesGET: watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}DELETE: delete a RoleGET: read the specified RolePATCH: partially update the specified RolePUT: replace the specified Role
/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}GET: watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/apis/rbac.authorization.k8s.io/v1/roles
- HTTP method
`GET`- Description
list or watch objects of kind Role
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RoleList schema |
| 401 - Unauthorized | Empty |
/apis/rbac.authorization.k8s.io/v1/watch/roles
- HTTP method
`GET`- Description
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | WatchEvent schema |
| 401 - Unauthorized | Empty |
/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
- HTTP method
`DELETE`- Description
delete collection of Role
Query parameters
| 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
| HTTP code | Reponse body |
|---|---|
| 200 - OK | Status schema |
| 401 - Unauthorized | Empty |
- HTTP method
`GET`- Description
list or watch objects of kind Role
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RoleList schema |
| 401 - Unauthorized | Empty |
- HTTP method
`POST`- Description
create a Role
Query parameters
| 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
| Parameter | Type | Description |
|---|---|---|
body | Role schema |
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | Role schema |
| 201 - Created | Role schema |
| 202 - Accepted | Role schema |
| 401 - Unauthorized | Empty |
/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
- HTTP method
`GET`- Description
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | WatchEvent schema |
| 401 - Unauthorized | Empty |
/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
Global path parameters
| Parameter | Type | Description |
|---|---|---|
name | string | name of the Role |
- HTTP method
`DELETE`- Description
delete a Role
Query parameters
| 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
- HTTP method
`GET`- Description
read the specified Role
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | Role schema |
| 401 - Unauthorized | Empty |
- HTTP method
`PATCH`- Description
partially update the specified Role
Query parameters
| 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
- HTTP method
`PUT`- Description
replace the specified Role
Query parameters
| 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
| Parameter | Type | Description |
|---|---|---|
body | Role schema |
HTTP responses
/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
Global path parameters
| Parameter | Type | Description |
|---|---|---|
name | string | name of the Role |
- HTTP method
`GET`- Description
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | WatchEvent schema |
| 401 - Unauthorized | Empty |