Skip to content

authentication_v1

BoundObjectReference

class lightkube.models.authentication_v1.BoundObjectReference(apiVersion=None, kind=None, name=None, uid=None)

BoundObjectReference is a reference to an object that a token is bound to.

parameters

  • apiVersion str - (optional) API version of the referent.
  • kind str - (optional) Kind of the referent. Valid kinds are 'Pod' and 'Secret'.
  • name str - (optional) Name of the referent.
  • uid str - (optional) UID of the referent.

TokenRequest

class lightkube.models.authentication_v1.TokenRequest(spec, apiVersion=None, kind=None, metadata=None, status=None)

TokenRequest requests a token for a given service account.

parameters

  • spec TokenRequestSpec - Spec holds information about the request being evaluated
  • apiVersion str - (optional) 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
  • kind str - (optional) 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
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info
  • status TokenRequestStatus - (optional) Status is filled in by the server and indicates whether the token can be authenticated.

TokenRequestSpec

class lightkube.models.authentication_v1.TokenRequestSpec(audiences, boundObjectRef=None, expirationSeconds=None)

TokenRequestSpec contains client provided parameters of a token request.

parameters

  • audiences List[str] - Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.
  • boundObjectRef BoundObjectReference - (optional) BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation.
  • expirationSeconds int - (optional) ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response.

TokenRequestStatus

class lightkube.models.authentication_v1.TokenRequestStatus(expirationTimestamp, token)

TokenRequestStatus is the result of a token request.

parameters

  • expirationTimestamp meta_v1.Time - ExpirationTimestamp is the time of expiration of the returned token.
  • token str - Token is the opaque bearer token.

TokenReview

class lightkube.models.authentication_v1.TokenReview(spec, apiVersion=None, kind=None, metadata=None, status=None)

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

parameters

  • spec TokenReviewSpec - Spec holds information about the request being evaluated
  • apiVersion str - (optional) 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
  • kind str - (optional) 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
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info
  • status TokenReviewStatus - (optional) Status is filled in by the server and indicates whether the request can be authenticated.

TokenReviewSpec

class lightkube.models.authentication_v1.TokenReviewSpec(audiences=None, token=None)

TokenReviewSpec is a description of the token authentication request.

parameters

  • audiences List[str] - (optional) Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.
  • token str - (optional) Token is the opaque bearer token.

TokenReviewStatus

class lightkube.models.authentication_v1.TokenReviewStatus(audiences=None, authenticated=None, error=None, user=None)

TokenReviewStatus is the result of the token authentication request.

parameters

  • audiences List[str] - (optional) Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.
  • authenticated bool - (optional) Authenticated indicates that the token was associated with a known user.
  • error str - (optional) Error indicates that the token couldn't be checked
  • user UserInfo - (optional) User is the UserInfo associated with the provided token.

UserInfo

class lightkube.models.authentication_v1.UserInfo(extra=None, groups=None, uid=None, username=None)

UserInfo holds the information about the user needed to implement the user.Info interface.

parameters

  • extra dict - (optional) Any additional information provided by the authenticator.
  • groups List[str] - (optional) The names of groups this user is a part of.
  • uid str - (optional) A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
  • username str - (optional) The name that uniquely identifies this user among all active users.