LocalSubjectAccessReview [authorization.openshift.io/v1] - Authorization APIs | API reference

Specification
API endpoints
- /apis/authorization.openshift.io/v1/namespaces/{namespace}/localsubjectaccessreviews

Description

LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Required

namespace
verb
resourceAPIGroup
resourceAPIVersion
resource
resourceName
path
isNonResourceURL
user
groups
scopes

Specification

Property Type Description

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
`content`	`RawExtension`	Content is the actual content of the request for create and update
`groups`	`array (string)`	Groups is optional. Groups is the list of groups to which the user belongs.
`isNonResourceURL`	`boolean`	IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)
`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
`namespace`	`string`	Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces
`path`	`string`	Path is the path of a non resource URL
`resource`	`string`	Resource is one of the existing resource types
`resourceAPIGroup`	`string`	Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined
`resourceAPIVersion`	`string`	Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined
`resourceName`	`string`	ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"
`scopes`	`array (string)`	Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.
`user`	`string`	user is optional. If both user and Groups are empty, the current authenticated user is used.
`verb`	`string`	Verb is one of: get, list, watch, create, update, delete

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

content

RawExtension

Content is the actual content of the request for create and update

groups

array (string)

Groups is optional. Groups is the list of groups to which the user belongs.

isNonResourceURL

boolean

IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)

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

namespace

string

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces

path

string

Path is the path of a non resource URL

resource

string

Resource is one of the existing resource types

resourceAPIGroup

string

Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined

resourceAPIVersion

string

Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined

resourceName

string

ResourceName is the name of the resource being requested for a "get" or deleted for a "delete"

scopes

array (string)

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". Nil for a self-SAR, means "use the scopes on this request". Nil for a regular SAR, means the same as empty.

user

string

user is optional. If both user and Groups are empty, the current authenticated user is used.

verb

string

Verb is one of: get, list, watch, create, update, delete

API endpoints

The following API endpoints are available:

/apis/authorization.openshift.io/v1/namespaces/{namespace}/localsubjectaccessreviews
- POST: create a LocalSubjectAccessReview

/apis/authorization.openshift.io/v1/namespaces/{namespace}/localsubjectaccessreviews

Table 1. Global path parameters
Parameter	Type	Description
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 2. Global query parameters
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.
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: POST
Description: create a LocalSubjectAccessReview

Table 3. Body parameters
Parameter	Type	Description
`body`	`LocalSubjectAccessReview` schema

Table 4. HTTP responses
HTTP code	Reponse body
200 - OK	`LocalSubjectAccessReview` schema
201 - Created	`LocalSubjectAccessReview` schema
202 - Accepted	`LocalSubjectAccessReview` schema
401 - Unauthorized	Empty