// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="subjectaccessreview-authorization-k8s-io-v1"]
= SubjectAccessReview [authorization.k8s.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
SubjectAccessReview checks whether or not a user or group can perform an action.
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| 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`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`]
| Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

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

| `status`
| `object`
| SubjectAccessReviewStatus

|===
=== .spec
Description::
+
--
SubjectAccessReviewSpec is a description of the access request.  Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `extra`
| `object`
| Extra corresponds to the user.Info.GetExtra() method from the authenticator.  Since that is input to the authorizer it needs a reflection here.

| `extra{}`
| `array (string)`
|

| `groups`
| `array (string)`
| Groups is the groups you're testing for.

| `nonResourceAttributes`
| `object`
| NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

| `resourceAttributes`
| `object`
| ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

| `uid`
| `string`
| UID information about the requesting user.

| `user`
| `string`
| User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups

|===
=== .spec.extra
Description::
+
--
Extra corresponds to the user.Info.GetExtra() method from the authenticator.  Since that is input to the authorizer it needs a reflection here.
--

Type::
  `object`




=== .spec.nonResourceAttributes
Description::
+
--
NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `path`
| `string`
| Path is the URL path of the request

| `verb`
| `string`
| Verb is the standard HTTP verb

|===
=== .spec.resourceAttributes
Description::
+
--
ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `group`
| `string`
| Group is the API Group of the Resource.  "*" means all.

| `name`
| `string`
| Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.

| `namespace`
| `string`
| 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

| `resource`
| `string`
| Resource is one of the existing resource types.  "*" means all.

| `subresource`
| `string`
| Subresource is one of the existing resource types.  "" means none.

| `verb`
| `string`
| Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy.  "*" means all.

| `version`
| `string`
| Version is the API Version of the Resource.  "*" means all.

|===
=== .status
Description::
+
--
SubjectAccessReviewStatus
--

Type::
  `object`

Required::
  - `allowed`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `allowed`
| `boolean`
| Allowed is required. True if the action would be allowed, false otherwise.

| `denied`
| `boolean`
| Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.

| `evaluationError`
| `string`
| 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.

| `reason`
| `string`
| Reason is optional.  It indicates why a request was allowed or denied.

|===

== API endpoints

The following API endpoints are available:

* `/apis/authorization.k8s.io/v1/subjectaccessreviews`
- `POST`: create a SubjectAccessReview


=== /apis/authorization.k8s.io/v1/subjectaccessreviews


.Global query parameters
[cols="1,1,2",options="header"]
|===
| 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
| `fieldManager`
| `string`
| 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`
| 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.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
|===

HTTP method::
  `POST`

Description::
  create a SubjectAccessReview



.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema
|
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema
| 201 - Created
| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema
| 202 - Accepted
| xref:../authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc#subjectaccessreview-authorization-k8s-io-v1[`SubjectAccessReview`] schema
| 401 - Unauthorized
| Empty
|===


