case class TokenReviewStatus(audiences: Optional[Vector[String]] = Optional.Absent, authenticated: Optional[Boolean] = Optional.Absent, error: Optional[String] = Optional.Absent, user: Optional[UserInfo] = Optional.Absent) extends Product with Serializable

TokenReviewStatus is the result of the token authentication request.

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TokenReviewStatus
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TokenReviewStatus(audiences: Optional[Vector[String]] = Optional.Absent, authenticated: Optional[Boolean] = Optional.Absent, error: Optional[String] = Optional.Absent, user: Optional[UserInfo] = Optional.Absent)

    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

Value Members

  1. val audiences: Optional[Vector[String]]
  2. val authenticated: Optional[Boolean]
  3. val error: Optional[String]
  4. def getAudiences: IO[K8sFailure, Vector[String]]

    Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  5. def getAuthenticated: IO[K8sFailure, Boolean]

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

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

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  6. def getError: IO[K8sFailure, String]

    Error indicates that the token couldn't be checked

    Error indicates that the token couldn't be checked

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  7. def getUser: IO[K8sFailure, UserInfo]

    Gets user.

    Gets user.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  8. val user: Optional[UserInfo]