Type Members

1.  case class LocalSubjectAccessReview(metadata: Optional[ObjectMeta] = Optional.Absent, spec: SubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus] = Optional.Absent) extends Product with Serializable

   LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace.

   LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

2.  class LocalSubjectAccessReviewFields extends AnyRef
3.  case class NonResourceAttributes(path: Optional[String] = Optional.Absent, verb: Optional[String] = Optional.Absent) extends Product with Serializable

   NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

   NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

   path

   Path is the URL path of the request

   verb

   Verb is the standard HTTP verb

4.  class NonResourceAttributesFields extends AnyRef
5.  case class NonResourceRule(nonResourceURLs: Optional[Vector[String]] = Optional.Absent, verbs: Vector[String]) extends Product with Serializable

   NonResourceRule holds information that describes a rule for the non-resource

   NonResourceRule holds information that describes a rule for the non-resource

   nonResourceURLs

   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

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

6.  class NonResourceRuleFields extends AnyRef
7.  case class ResourceAttributes(group: Optional[String] = Optional.Absent, name: Optional[String] = Optional.Absent, namespace: Optional[String] = Optional.Absent, resource: Optional[String] = Optional.Absent, subresource: Optional[String] = Optional.Absent, verb: Optional[String] = Optional.Absent, version: Optional[String] = Optional.Absent) extends Product with Serializable

   ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

   ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

   group

   Group is the API Group of the Resource. "*" means all.

   name

   Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.

   namespace

   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

   resource

   Resource is one of the existing resource types. "*" means all.

   subresource

   Subresource is one of the existing resource types. "" means none.

   verb

   Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.

   version

   Version is the API Version of the Resource. "*" means all.

8.  class ResourceAttributesFields extends AnyRef
9.  case class ResourceRule(apiGroups: Optional[Vector[String]] = Optional.Absent, resourceNames: Optional[Vector[String]] = Optional.Absent, resources: Optional[Vector[String]] = Optional.Absent, verbs: Vector[String]) extends Product with Serializable

   ResourceRule is the list of actions the subject is allowed to perform on resources.

   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.

   apiGroups

   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

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

   resources

   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

   Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.

10.  class ResourceRuleFields extends AnyRef
11.  case class SelfSubjectAccessReview(metadata: Optional[ObjectMeta] = Optional.Absent, spec: SelfSubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus] = Optional.Absent) extends Product with Serializable

    SelfSubjectAccessReview checks whether or the current user can perform an action.

    SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

12.  class SelfSubjectAccessReviewFields extends AnyRef
13.  case class SelfSubjectAccessReviewSpec(nonResourceAttributes: Optional[NonResourceAttributes] = Optional.Absent, resourceAttributes: Optional[ResourceAttributes] = Optional.Absent) extends Product with Serializable

    SelfSubjectAccessReviewSpec is a description of the access request.

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

14.  class SelfSubjectAccessReviewSpecFields extends AnyRef
15.  case class SelfSubjectRulesReview(metadata: Optional[ObjectMeta] = Optional.Absent, spec: SelfSubjectRulesReviewSpec, status: Optional[SubjectRulesReviewStatus] = Optional.Absent) extends Product with Serializable

    SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace.

    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.

16.  class SelfSubjectRulesReviewFields extends AnyRef
17.  case class SelfSubjectRulesReviewSpec(namespace: Optional[String] = Optional.Absent) extends Product with Serializable

    SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.

    SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.

    namespace

    Namespace to evaluate rules for. Required.

18.  class SelfSubjectRulesReviewSpecFields extends AnyRef
19.  case class SubjectAccessReview(metadata: Optional[ObjectMeta] = Optional.Absent, spec: SubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus] = Optional.Absent) extends Product with Serializable

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

20.  class SubjectAccessReviewFields extends AnyRef
21.  case class SubjectAccessReviewSpec(extra: Optional[Map[String, Vector[String]]] = Optional.Absent, groups: Optional[Vector[String]] = Optional.Absent, nonResourceAttributes: Optional[NonResourceAttributes] = Optional.Absent, resourceAttributes: Optional[ResourceAttributes] = Optional.Absent, uid: Optional[String] = Optional.Absent, user: Optional[String] = Optional.Absent) extends Product with Serializable

    SubjectAccessReviewSpec is a description of the access request.

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

    extra

    Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.

    groups

    Groups is the groups you're testing for.

    uid

    UID information about the requesting user.

    user

    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

22.  class SubjectAccessReviewSpecFields extends AnyRef
23.  case class SubjectAccessReviewStatus(allowed: Boolean, denied: Optional[Boolean] = Optional.Absent, evaluationError: Optional[String] = Optional.Absent, reason: Optional[String] = Optional.Absent) extends Product with Serializable

    SubjectAccessReviewStatus

    SubjectAccessReviewStatus

    allowed

    Allowed is required. True if the action would be allowed, false otherwise.

    denied

    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

    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

    Reason is optional. It indicates why a request was allowed or denied.

24.  class SubjectAccessReviewStatusFields extends AnyRef
25.  case class SubjectRulesReviewStatus(evaluationError: Optional[String] = Optional.Absent, incomplete: Boolean, nonResourceRules: Vector[NonResourceRule], resourceRules: Vector[ResourceRule]) extends Product with Serializable

    SubjectRulesReviewStatus contains the result of a rules check.

    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.

    evaluationError

    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

    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

    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.

    resourceRules

    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.

26.  class SubjectRulesReviewStatusFields extends AnyRef