## Top Level API Objects

- v1beta1.SelfSubjectAccessReview

- v1beta1.SubjectAccessReview

- v1beta1.LocalSubjectAccessReview

## Definitions

### v1.OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
apiVersion | API version of the referent. | true | string |
kind | Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | true | string |
name | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | true | string |
uid | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | true | string |
controller | If true, this reference points to the managing controller. | false | boolean | false

### v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
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: http://kubernetes.io/docs/user-guide/identifiers#names | false | string |

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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within 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: http://kubernetes.io/docs/user-guide/namespaces

false

string

selfLink | SelfLink is a URL representing this object. Populated by the system. Read-only. | false | string |
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: http://kubernetes.io/docs/user-guide/identifiers#uids | false | string |

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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | false | integer (int64) |

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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. 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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false

string (date-time)

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. | false | integer (int64) |
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: http://kubernetes.io/docs/user-guide/labels | false | object |
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: http://kubernetes.io/docs/user-guide/annotations | false | object |
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. | false | v1.OwnerReference array |
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. | false | string array |
clusterName | The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. | false | string |

### v1beta1.SelfSubjectAccessReview

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string |
metadata |  | false | v1.ObjectMeta |
spec | Spec holds information about the request being evaluated. user and groups must be empty | true | v1beta1.SelfSubjectAccessReviewSpec |
status | Status is filled in by the server and indicates whether the request is allowed or not | false | v1beta1.SubjectAccessReviewStatus |

### v1beta1.SubjectAccessReview

SubjectAccessReview checks whether or not a user or group can perform an action.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string |
metadata |  | false | v1.ObjectMeta |
spec | Spec holds information about the request being evaluated | true | v1beta1.SubjectAccessReviewSpec |
status | Status is filled in by the server and indicates whether the request is allowed or not | false | v1beta1.SubjectAccessReviewStatus |

### v1beta1.LocalSubjectAccessReview

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string |
metadata |  | false | v1.ObjectMeta |
spec | Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. | true | v1beta1.SubjectAccessReviewSpec |
status | Status is filled in by the server and indicates whether the request is allowed or not | false | v1beta1.SubjectAccessReviewStatus |

### unversioned.APIResourceList

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds | false | string |
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources | false | string |
groupVersion | groupVersion is the group and version this APIResourceList is for. | true | string |
resources | resources contains the name of the resources and if they are namespaced. | true | unversioned.APIResource array |

### v1beta1.ResourceAttributes

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
namespace | Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview | false | string |
verb | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. | false | string |
group | Group is the API Group of the Resource. "*" means all. | false | string |
version | Version is the API Version of the Resource. "*" means all. | false | string |
resource | Resource is one of the existing resource types. "*" means all. | false | string |
subresource | Subresource is one of the existing resource types. "" means none. | false | string |
name | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. | false | string |

### v1beta1.NonResourceAttributes

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
path | Path is the URL path of the request | false | string |
verb | Verb is the standard HTTP verb | false | string |

### v1beta1.SelfSubjectAccessReviewSpec

SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
resourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request | false | v1beta1.ResourceAttributes |
nonResourceAttributes | NonResourceAttributes describes information for a non-resource access request | false | v1beta1.NonResourceAttributes |

### v1beta1.SubjectAccessReviewSpec

SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
resourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request | false | v1beta1.ResourceAttributes |
nonResourceAttributes | NonResourceAttributes describes information for a non-resource access request | false | v1beta1.NonResourceAttributes |
user | User is the user you’re testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups | false | string |
group | Groups is the groups you’re testing for. | false | string array |
extra | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | false | object |

### unversioned.APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
name | name is the name of the resource. | true | string |
namespaced | namespaced indicates if a resource is namespaced or not. | true | boolean | false
kind | kind is the kind for the resource (e.g. Foo is the kind for a resource foo) | true | string |

### v1beta1.SubjectAccessReviewStatus

SubjectAccessReviewStatus

Name | Description | Required | Schema | Default
--- | --- | --- | --- | ---
allowed | Allowed is required. True if the action would be allowed, false otherwise. | true | boolean | false
reason | Reason is optional. It indicates why a request was allowed or denied. | false | string |
evaluationError | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. | false | string |

### any

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.