Module authorization/v1beta1

@pulumi/kubernetes > authorization > v1beta1

Index

types/input.ts types/output.ts

function isLocalSubjectAccessReview

isLocalSubjectAccessReview(o: any): boolean

function isSelfSubjectAccessReview

isSelfSubjectAccessReview(o: any): boolean

function isSelfSubjectRulesReview

isSelfSubjectRulesReview(o: any): boolean

function isSubjectAccessReview

isSubjectAccessReview(o: any): boolean

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: SubjectAccessReviewSpec;

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.

property status

status: SubjectAccessReviewStatus;

Status is filled in by the server and indicates whether the request is allowed or not

interface NonResourceAttributes

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

property path

path: string;

Path is the URL path of the request

property verb

verb: string;

Verb is the standard HTTP verb

interface NonResourceRule

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

property nonResourceURLs

nonResourceURLs: string[];

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.

property verbs

verbs: string[];

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

interface ResourceAttributes

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

property group

group: string;

Group is the API Group of the Resource. “*” means all.

property name

name: string;

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

property namespace

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

property resource

resource: string;

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

property subresource

subresource: string;

Subresource is one of the existing resource types. “” means none.

property verb

verb: string;

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

property version

version: string;

Version is the API Version of the Resource. “*” means all.

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

property apiGroups

apiGroups: string[];

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.

property resourceNames

resourceNames: string[];

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

property resources

resources: string[];

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.

property verbs

verbs: string[];

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

interface 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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: SelfSubjectAccessReviewSpec;

Spec holds information about the request being evaluated. user and groups must be empty

property status

status: SubjectAccessReviewStatus;

Status is filled in by the server and indicates whether the request is allowed or not

interface SelfSubjectAccessReviewSpec

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

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: SelfSubjectRulesReviewSpec;

Spec holds information about the request being evaluated.

property status

status: SubjectRulesReviewStatus;

Status is filled in by the server and indicates the set of actions a user can perform.

interface SelfSubjectRulesReviewSpec

property namespace

namespace: string;

Namespace to evaluate rules for. Required.

interface SubjectAccessReview

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

property apiVersion

apiVersion: string;

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/api-conventions.md#resources

property kind

kind: string;

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/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: SubjectAccessReviewSpec;

Spec holds information about the request being evaluated

property status

status: SubjectAccessReviewStatus;

Status is filled in by the server and indicates whether the request is allowed or not

interface SubjectAccessReviewSpec

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

property extra

extra: object;

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

property group

group: string[];

Groups is the groups you’re testing for.

property nonResourceAttributes

nonResourceAttributes: NonResourceAttributes;

NonResourceAttributes describes information for a non-resource access request

property resourceAttributes

resourceAttributes: ResourceAttributes;

ResourceAuthorizationAttributes describes information for a resource access request

property uid

uid: string;

UID information about the requesting user.

property user

user: string;

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

interface SubjectAccessReviewStatus

SubjectAccessReviewStatus

property allowed

allowed: boolean;

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

property denied

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.

property evaluationError

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.

property reason

reason: string;

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

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

property evaluationError

evaluationError: string;

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.

property incomplete

incomplete: boolean;

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.

property nonResourceRules

nonResourceRules: NonResourceRule[];

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.

property resourceRules

resourceRules: ResourceRule[];

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.