This is a cache of https://docs.okd.io/4.10/rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.html. It is a snapshot of the page at 2024-11-24T22:32:35.536+0000.
SubjectRulesReview [authorization.openshift.io/v1] - Authorization APIs | API reference | OKD 4.10
  1. Documentation
×

SubjectRulesReview [authorization.openshift.io/v1]

Description

SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace

Type

object

Required

  • spec

Specification

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

spec

object

SubjectRulesReviewSpec adds information about how to conduct the check

status

object

SubjectRulesReviewStatus is contains the result of a rules check

.spec

Description

SubjectRulesReviewSpec adds information about how to conduct the check

Type

object

Required

  • user

  • groups

  • scopes

Property Type Description

groups

array (string)

Groups is optional. Groups is the list of groups to which the user belongs. At least one of user and Groups must be specified.

scopes

array (string)

Scopes to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups".

user

string

user is optional. At least one of user and Groups must be specified.

.status

Description

SubjectRulesReviewStatus is contains the result of a rules check

Type

object

Required

  • rules

Property Type Description

evaluationError

string

EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.

rules

array

Rules is the list of rules (no particular sort) that are allowed for the subject

rules[]

object

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

.status.rules

Description

Rules is the list of rules (no particular sort) that are allowed for the subject

Type

array

.status.rules[]

Description

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Type

object

Required

  • verbs

  • resources

Property Type Description

apiGroups

array (string)

APIGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed

attributeRestrictions

RawExtension

AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

nonResourceURLs

array (string)

NonResourceURLsSlice 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 This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.

resourceNames

array (string)

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

resources

array (string)

Resources is a list of resources this rule applies to. ResourceAll represents all resources.

verbs

array (string)

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

API endpoints

The following API endpoints are available:

  • /apis/authorization.openshift.io/v1/namespaces/{namespace}/subjectrulesreviews

    • POST: create a SubjectRulesReview

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

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 SubjectRulesReview

Table 3. Body parameters
Parameter Type Description

body

SubjectRulesReview schema
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

SubjectRulesReview schema

201 - Created

SubjectRulesReview schema

202 - Accepted

SubjectRulesReview schema

401 - Unauthorized

Empty