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

toc::[]


Description::
+
--
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::
  `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`
| SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.

| `status`
| `object`
| SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

|===
=== .spec
Description::
+
--
SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.
--

Type::
  `object`




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

| `namespace`
| `string`
| Namespace to evaluate rules for. Required.

|===
=== .status
Description::
+
--
SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.
--

Type::
  `object`

Required::
  - `resourceRules`
  - `nonResourceRules`
  - `incomplete`



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

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

| `incomplete`
| `boolean`
| 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.

| `nonResourceRules`
| `array`
| 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.

| `nonResourceRules[]`
| `object`
| NonResourceRule holds information that describes a rule for the non-resource

| `resourceRules`
| `array`
| 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.

| `resourceRules[]`
| `object`
| ResourceRule 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.

|===
=== .status.nonResourceRules
Description::
+
--
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::
  `array`




=== .status.nonResourceRules[]
Description::
+
--
NonResourceRule holds information that describes a rule for the non-resource
--

Type::
  `object`

Required::
  - `verbs`



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

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

| `verbs`
| `array (string)`
| Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options.  "*" means all.

|===
=== .status.resourceRules
Description::
+
--
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::
  `array`




=== .status.resourceRules[]
Description::
+
--
ResourceRule 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::
  `object`

Required::
  - `verbs`



[cols="1,1,1",options="header"]
|===
| 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.  "*" means all.

| `resourceNames`
| `array (string)`
| ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.  "*" means all.

| `resources`
| `array (string)`
| 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.

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

|===

== API endpoints

The following API endpoints are available:

* `/apis/authorization.k8s.io/v1/selfsubjectrulesreviews`
- `POST`: create a SelfSubjectRulesReview


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


.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 SelfSubjectRulesReview



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

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


