Kubernetes Reference
SubjectAccessReview

SubjectAccessReview

SubjectAccessReview

apiVersion: authorization.k8s.io/v1
import "k8s.io/api/authorization/v1"

SubjectAccessReview

SubjectAccessReview checks whether or not a user or group can perform an action.

  • apiVersion: authorization.k8s.io/v1

  • kind: SubjectAccessReview

  • metadata (ObjectMeta)

  • spec (SubjectAccessReviewSpec), required
    Spec holds information about the request being evaluated

  • status (SubjectAccessReviewStatus)
    Status is filled in by the server and indicates whether the request is allowed or not

SubjectAccessReviewSpec

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

  • extra (map[string][]string)
    Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
  • groups ([]string)
    Groups is the groups you’re testing for.
  • nonResourceAttributes (NonResourceAttributes)
    NonResourceAttributes describes information for a non-resource access request
    NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
    • nonResourceAttributes.path (string)
      Path is the URL path of the request
    • nonResourceAttributes.verb (string)
      Verb is the standard HTTP verb
  • resourceAttributes (ResourceAttributes)
    ResourceAuthorizationAttributes describes information for a resource access request
    ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
    • resourceAttributes.group (string)
      Group is the API Group of the Resource. “*” means all.
    • resourceAttributes.name (string)
      Name is the name of the resource being requested for a “get” or deleted for a “delete”. "" (empty) means all.
    • resourceAttributes.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
    • resourceAttributes.resource (string)
      Resource is one of the existing resource types. “*” means all.
    • resourceAttributes.subresource (string)
      Subresource is one of the existing resource types. "" means none.
    • resourceAttributes.verb (string)
      Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. “*” means all.
    • resourceAttributes.version (string)
      Version is the API Version of the Resource. “*” means all.
  • 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

SubjectAccessReviewStatus

SubjectAccessReviewStatus

  • allowed (boolean), required
    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.

Operations

create create a SubjectAccessReview

HTTP Request

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

Parameters
Response

200 (SubjectAccessReview): OK
201 (SubjectAccessReview): Created
202 (SubjectAccessReview): Accepted
401: Unauthorized

What's on this Page