replaceRbacAuthorizationV1NamespacedRole

replace the specified Role

PUT/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

Source: specs/apis__rbac.authorization.k8s.io__v1_openapi.json
Revision: 9a79c3bd90f7
Active snapshot: 2a9112600697

Request

Path Parameters

name string required: name of the Role
namespace string required: object name and auth scope, such as for teams and projects

Query Parameters

pretty string optional: If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
dryRun string optional: 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
fieldManager string optional: fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
fieldValidation string optional: 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 Params

required

*/*io.k8s.api.rbac.v1.Role object

apiVersion string

optional

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

optional

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

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

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]

optional

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]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Responses

application/cbor io.k8s.api.rbac.v1.Role object

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/json io.k8s.api.rbac.v1.Role object

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/vnd.kubernetes.protobuf io.k8s.api.rbac.v1.Role object

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/yaml io.k8s.api.rbac.v1.Role object

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/cbor io.k8s.api.rbac.v1.Role object

Created

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/json io.k8s.api.rbac.v1.Role object

Created

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/vnd.kubernetes.protobuf io.k8s.api.rbac.v1.Role object

Created

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

application/yaml io.k8s.api.rbac.v1.Role object

Created

apiVersion string

optional

kind string

optional

metadata

optional

metadata is the standard object's metadata.

Default: {}

rules array[io.k8s.api.rbac.v1.PolicyRule object]

optional

rules holds all the PolicyRules for this Role

items io.k8s.api.rbac.v1.PolicyRule 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.

apiGroups array[string]

optional

nonResourceURLs array[string]

optional

resourceNames array[string]

optional

resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

resources array[string]

optional

resources is a list of resources this rule applies to. '*' represents all resources.

verbs array[string]

required

verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

Unauthorized

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

name *

name of the Role

namespace *

object name and auth scope, such as for teams and projects

pretty

If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

dryRun

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

fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

fieldValidation

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.

Request Sample: Shell / cURL

curl --request PUT \
  --header 'content-type: */*' \
  --url '/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}'