zio-k8s-client/com.coralogix.zio.k8s.model.authentication.v1beta1

com.coralogix.zio.k8s.model.authentication.v1beta1

package com.coralogix.zio.k8s.model.authentication.v1beta1

Type members

Classlikes

case class TokenReview(metadata: Optional[ObjectMeta], spec: TokenReviewSpec, status: Optional[TokenReviewStatus])

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.

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.

Companion
object
object TokenReview extends TokenReviewFields
Companion
class
class TokenReviewFields(_prefix: Chunk[String])
case class TokenReviewSpec(audiences: Optional[Vector[String]], token: Optional[String])

TokenReviewSpec is a description of the token authentication request.

TokenReviewSpec is a description of the token authentication request.

Value Params
audiences

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

Token is the opaque bearer token.

Companion
object
object TokenReviewSpec extends TokenReviewSpecFields
Companion
class
class TokenReviewSpecFields(_prefix: Chunk[String])
case class TokenReviewStatus(audiences: Optional[Vector[String]], authenticated: Optional[Boolean], error: Optional[String], user: Optional[UserInfo])

TokenReviewStatus is the result of the token authentication request.

TokenReviewStatus is the result of the token authentication request.

Value Params
audiences

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

Authenticated indicates that the token was associated with a known user.

error

Error indicates that the token couldn't be checked

Companion
object
object TokenReviewStatus extends TokenReviewStatusFields
Companion
class
class TokenReviewStatusFields(_prefix: Chunk[String])
case class UserInfo(extra: Optional[Map[String, Vector[String]]], groups: Optional[Vector[String]], uid: Optional[String], username: Optional[String])

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

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

Value Params
extra

Any additional information provided by the authenticator.

groups

The names of groups this user is a part of.

uid

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

The name that uniquely identifies this user among all active users.

Companion
object
object UserInfo extends UserInfoFields
Companion
class
class UserInfoFields(_prefix: Chunk[String])