Chapter 7. SubjectRulesReview [authorization.openshift.io/v1]
- Description
SubjectRulesReview is a resource you can create to determine which actions another user can perform in a 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
-
spec
-
7.1. Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
|
| SubjectRulesReviewSpec adds information about how to conduct the check |
|
| SubjectRulesReviewStatus is contains the result of a rules check |
7.1.1. .spec
- Description
- SubjectRulesReviewSpec adds information about how to conduct the check
- Type
-
object
- Required
-
user
-
groups
-
scopes
-
Property | Type | Description |
---|---|---|
|
| 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 to use for the evaluation. Empty means "use the unscoped (full) permissions of the user/groups". |
|
| User is optional. At least one of User and Groups must be specified. |
7.1.2. .status
- Description
- SubjectRulesReviewStatus is contains the result of a rules check
- Type
-
object
- Required
-
rules
-
Property | Type | Description |
---|---|---|
|
| EvaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated. |
|
| Rules is the list of rules (no particular sort) that are allowed for the subject |
|
| 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. |
7.1.3. .status.rules
- Description
- Rules is the list of rules (no particular sort) that are allowed for the subject
- Type
-
array
7.1.4. .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 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 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. | |
|
| 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 is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
|
| Resources is a list of resources this rule applies to. ResourceAll represents all resources. |
|
| Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
7.2. API endpoints
The following API endpoints are available:
/apis/authorization.openshift.io/v1/namespaces/{namespace}/subjectrulesreviews
-
POST
: create a SubjectRulesReview
-
7.2.1. /apis/authorization.openshift.io/v1/namespaces/{namespace}/subjectrulesreviews
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| 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 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 instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the |
|
| If 'true', then the output is pretty printed. |
- HTTP method
-
POST
- Description
- create a SubjectRulesReview
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | Empty |