resources.selfSubjectRulesReviews

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server’s authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

Type: attribute set of (submodule)

Default: { }

Declared by:

resources.selfSubjectRulesReviews.<name>.apiVersion

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

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.kind

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

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (submodule)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Type: null or (attribute set of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

Type: null or signed integer

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

Type: null or (list of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

Type: null or (list of (submodule))

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.apiVersion

APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.operation

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.subresource

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.managedFields.*.time

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.namespace

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.blockOwnerDeletion

If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: null or boolean

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.ownerReferences.<name>.uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: null or (string)

Declared by:

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.metadata.uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.spec

Spec holds information about the request being evaluated.

Type: submodule

Declared by:

resources.selfSubjectRulesReviews.<name>.spec.namespace

Namespace to evaluate rules for. Required.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.status

Status is filled in by the server and indicates the set of actions a user can perform.

Type: null or (submodule)

Declared by:

resources.selfSubjectRulesReviews.<name>.status.evaluationError

EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn’t support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.

Type: null or (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.status.incomplete

Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn’t support rules evaluation.

Type: boolean

Declared by:

resources.selfSubjectRulesReviews.<name>.status.nonResourceRules

NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn’t significant, may contain duplicates, and possibly be incomplete.

Type: list of (submodule)

Declared by:

resources.selfSubjectRulesReviews.<name>.status.nonResourceRules.*.nonResourceURLs

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. "" means all.

Type: null or (list of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.status.nonResourceRules.*.verbs

Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. “*” means all.

Type: list of (string)

Declared by:

resources.selfSubjectRulesReviews.<name>.status.resourceRules

ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn’t significant, may contain duplicates, and possibly be incomplete.

Type: list of (submodule)

Declared by:

resources.selfSubjectRulesReviews.<name>.status.resourceRules.*.apiGroups

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. “*” means all.

Type: null or (list of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.status.resourceRules.*.resourceNames

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. “*” means all.

Type: null or (list of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.status.resourceRules.*.resources

Resources is a list of resources this rule applies to. “" means all in the specified apiGroups. "/foo” represents the subresource ‘foo’ for all resources in the specified apiGroups.

Type: null or (list of (string))

Declared by:

resources.selfSubjectRulesReviews.<name>.status.resourceRules.*.verbs

Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. “*” means all.

Type: list of (string)

Declared by: