zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.model/com.coralogix.zio.k8s.model.authorization.v1

com.coralogix.zio.k8s.model.authorization.v1

package com.coralogix.zio.k8s.model.authorization.v1

Members list

Type members

Classlikes

case class LocalSubjectAccessReview(metadata: Optional[ObjectMeta], spec: SubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus])

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LocalSubjectAccessReview extends LocalSubjectAccessReviewFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class LocalSubjectAccessReviewFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class NonResourceAttributes(path: Optional[String], verb: Optional[String])

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

Value parameters

path

Path is the URL path of the request

verb

Verb is the standard HTTP verb

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NonResourceAttributes extends NonResourceAttributesFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NonResourceAttributesFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NonResourceAttributes.type
case class NonResourceRule(nonResourceURLs: Optional[Vector[String]], verbs: Vector[String])

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

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

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NonResourceRule extends NonResourceRuleFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NonResourceRuleFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NonResourceRule.type
case class ResourceAttributes(group: Optional[String], name: Optional[String], namespace: Optional[String], resource: Optional[String], subresource: Optional[String], verb: Optional[String], version: Optional[String])

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

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceAttributes extends ResourceAttributesFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ResourceAttributesFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ResourceAttributes.type
case class ResourceRule(apiGroups: Optional[Vector[String]], resourceNames: Optional[Vector[String]], resources: Optional[Vector[String]], verbs: Vector[String])

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.

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.

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ResourceRule extends ResourceRuleFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ResourceRuleFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ResourceRule.type
case class SelfSubjectAccessReview(metadata: Optional[ObjectMeta], spec: SelfSubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus])

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

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelfSubjectAccessReview extends SelfSubjectAccessReviewFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SelfSubjectAccessReviewFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SelfSubjectAccessReviewSpec(nonResourceAttributes: Optional[NonResourceAttributes], resourceAttributes: Optional[ResourceAttributes])

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

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelfSubjectAccessReviewSpec extends SelfSubjectAccessReviewSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SelfSubjectAccessReviewSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SelfSubjectRulesReview(metadata: Optional[ObjectMeta], spec: SelfSubjectRulesReviewSpec, status: Optional[SubjectRulesReviewStatus])

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelfSubjectRulesReview extends SelfSubjectRulesReviewFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SelfSubjectRulesReviewFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SelfSubjectRulesReviewSpec(namespace: Optional[String])

SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.

SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview.

Value parameters

namespace

Namespace to evaluate rules for. Required.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SelfSubjectRulesReviewSpec extends SelfSubjectRulesReviewSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SelfSubjectRulesReviewSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SubjectAccessReview(metadata: Optional[ObjectMeta], spec: SubjectAccessReviewSpec, status: Optional[SubjectAccessReviewStatus])

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

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SubjectAccessReview extends SubjectAccessReviewFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SubjectAccessReviewFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SubjectAccessReview.type
case class SubjectAccessReviewSpec(extra: Optional[Map[String, Vector[String]]], groups: Optional[Vector[String]], nonResourceAttributes: Optional[NonResourceAttributes], resourceAttributes: Optional[ResourceAttributes], uid: Optional[String], user: Optional[String])

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

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

Value parameters

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SubjectAccessReviewSpec extends SubjectAccessReviewSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SubjectAccessReviewSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SubjectAccessReviewStatus(allowed: Boolean, denied: Optional[Boolean], evaluationError: Optional[String], reason: Optional[String])

SubjectAccessReviewStatus

SubjectAccessReviewStatus

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SubjectAccessReviewStatus extends SubjectAccessReviewStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SubjectAccessReviewStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class SubjectRulesReviewStatus(evaluationError: Optional[String], incomplete: Boolean, nonResourceRules: Vector[NonResourceRule], resourceRules: Vector[ResourceRule])

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.

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.

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SubjectRulesReviewStatus extends SubjectRulesReviewStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class SubjectRulesReviewStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Generated with