Kubernetes.Api.Authorization.V1Beta1

newtype LocalSubjectAccessReview

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.

Fields:

• metadata
• spec: Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
• status: Status is filled in by the server and indicates whether the request is allowed or not

Constructors

• LocalSubjectAccessReview { metadata :: Maybe ObjectMeta, spec :: Maybe SubjectAccessReviewSpec, status :: Maybe SubjectAccessReviewStatus }

Instances

• Newtype LocalSubjectAccessReview _
• Generic LocalSubjectAccessReview _
• Show LocalSubjectAccessReview
• Decode LocalSubjectAccessReview
• Encode LocalSubjectAccessReview
• Default LocalSubjectAccessReview

newtype NonResourceAttributes

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

Fields:

• path: Path is the URL path of the request
• verb: Verb is the standard HTTP verb

Constructors

• NonResourceAttributes { path :: Maybe String, verb :: Maybe String }

Instances

• Newtype NonResourceAttributes _
• Generic NonResourceAttributes _
• Show NonResourceAttributes
• Decode NonResourceAttributes
• Encode NonResourceAttributes
• Default NonResourceAttributes

newtype NonResourceRule

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

Fields:

• 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.

Constructors

• NonResourceRule { nonResourceURLs :: Maybe (Array String), verbs :: Maybe (Array String) }

Instances

• Newtype NonResourceRule _
• Generic NonResourceRule _
• Show NonResourceRule
• Decode NonResourceRule
• Encode NonResourceRule
• Default NonResourceRule

newtype ResourceAttributes

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

Fields:

• 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.

Constructors

• ResourceAttributes { group :: Maybe String, name :: Maybe String, namespace :: Maybe String, resource :: Maybe String, subresource :: Maybe String, verb :: Maybe String, version :: Maybe String }

Instances

• Newtype ResourceAttributes _
• Generic ResourceAttributes _
• Show ResourceAttributes
• Decode ResourceAttributes
• Encode ResourceAttributes
• Default ResourceAttributes

newtype ResourceRule

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.

Fields:

• 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.

Constructors

• ResourceRule { apiGroups :: Maybe (Array String), resourceNames :: Maybe (Array String), resources :: Maybe (Array String), verbs :: Maybe (Array String) }

Instances

• Newtype ResourceRule _
• Generic ResourceRule _
• Show ResourceRule
• Decode ResourceRule
• Encode ResourceRule
• Default ResourceRule

newtype SelfSubjectAccessReview

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

Fields:

• metadata
• spec: Spec holds information about the request being evaluated. user and groups must be empty
• status: Status is filled in by the server and indicates whether the request is allowed or not

Constructors

• SelfSubjectAccessReview { metadata :: Maybe ObjectMeta, spec :: Maybe SelfSubjectAccessReviewSpec, status :: Maybe SubjectAccessReviewStatus }

Instances

• Newtype SelfSubjectAccessReview _
• Generic SelfSubjectAccessReview _
• Show SelfSubjectAccessReview
• Decode SelfSubjectAccessReview
• Encode SelfSubjectAccessReview
• Default SelfSubjectAccessReview

newtype SelfSubjectAccessReviewSpec

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

Fields:

• nonResourceAttributes: NonResourceAttributes describes information for a non-resource access request
• resourceAttributes: ResourceAuthorizationAttributes describes information for a resource access request

Constructors

• SelfSubjectAccessReviewSpec { nonResourceAttributes :: Maybe NonResourceAttributes, resourceAttributes :: Maybe ResourceAttributes }

Instances

• Newtype SelfSubjectAccessReviewSpec _
• Generic SelfSubjectAccessReviewSpec _
• Show SelfSubjectAccessReviewSpec
• Decode SelfSubjectAccessReviewSpec
• Encode SelfSubjectAccessReviewSpec
• Default SelfSubjectAccessReviewSpec

newtype SelfSubjectRulesReview

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.

Fields:

• metadata
• spec: Spec holds information about the request being evaluated.
• status: Status is filled in by the server and indicates the set of actions a user can perform.

Constructors

• SelfSubjectRulesReview { metadata :: Maybe ObjectMeta, spec :: Maybe SelfSubjectRulesReviewSpec, status :: Maybe SubjectRulesReviewStatus }

Instances

• Newtype SelfSubjectRulesReview _
• Generic SelfSubjectRulesReview _
• Show SelfSubjectRulesReview
• Decode SelfSubjectRulesReview
• Encode SelfSubjectRulesReview
• Default SelfSubjectRulesReview

newtype SelfSubjectRulesReviewSpec

Fields:

• namespace: Namespace to evaluate rules for. Required.

Constructors

• SelfSubjectRulesReviewSpec { namespace :: Maybe String }

Instances

• Newtype SelfSubjectRulesReviewSpec _
• Generic SelfSubjectRulesReviewSpec _
• Show SelfSubjectRulesReviewSpec
• Decode SelfSubjectRulesReviewSpec
• Encode SelfSubjectRulesReviewSpec
• Default SelfSubjectRulesReviewSpec

newtype SubjectAccessReview

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

Fields:

• metadata
• spec: Spec holds information about the request being evaluated
• status: Status is filled in by the server and indicates whether the request is allowed or not

Constructors

• SubjectAccessReview { metadata :: Maybe ObjectMeta, spec :: Maybe SubjectAccessReviewSpec, status :: Maybe SubjectAccessReviewStatus }

Instances

• Newtype SubjectAccessReview _
• Generic SubjectAccessReview _
• Show SubjectAccessReview
• Decode SubjectAccessReview
• Encode SubjectAccessReview
• Default SubjectAccessReview

newtype SubjectAccessReviewSpec

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

Fields:

• extra: Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
• group: Groups is the groups you're testing for.
• nonResourceAttributes: NonResourceAttributes describes information for a non-resource access request
• resourceAttributes: ResourceAuthorizationAttributes describes information for a resource access request
• uid: UID information about the requesting user.
• user: User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups

Constructors

• SubjectAccessReviewSpec { extra :: Maybe (Object (Array String)), group :: Maybe (Array String), nonResourceAttributes :: Maybe NonResourceAttributes, resourceAttributes :: Maybe ResourceAttributes, uid :: Maybe String, user :: Maybe String }

Instances

• Newtype SubjectAccessReviewSpec _
• Generic SubjectAccessReviewSpec _
• Show SubjectAccessReviewSpec
• Decode SubjectAccessReviewSpec
• Encode SubjectAccessReviewSpec
• Default SubjectAccessReviewSpec

newtype SubjectAccessReviewStatus

SubjectAccessReviewStatus

Fields:

• 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.

Constructors

• SubjectAccessReviewStatus { allowed :: Maybe Boolean, denied :: Maybe Boolean, evaluationError :: Maybe String, reason :: Maybe String }

Instances

• Newtype SubjectAccessReviewStatus _
• Generic SubjectAccessReviewStatus _
• Show SubjectAccessReviewStatus
• Decode SubjectAccessReviewStatus
• Encode SubjectAccessReviewStatus
• Default SubjectAccessReviewStatus

newtype SubjectRulesReviewStatus

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.

Fields:

• 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.

Constructors

• SubjectRulesReviewStatus { evaluationError :: Maybe String, incomplete :: Maybe Boolean, nonResourceRules :: Maybe (Array NonResourceRule), resourceRules :: Maybe (Array ResourceRule) }

Instances

• Newtype SubjectRulesReviewStatus _
• Generic SubjectRulesReviewStatus _
• Show SubjectRulesReviewStatus
• Decode SubjectRulesReviewStatus
• Encode SubjectRulesReviewStatus
• Default SubjectRulesReviewStatus

getAPIResources :: Config -> Aff (Either Status APIResourceList)

get available resources