This is a cache of https://docs.okd.io/4.10/rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.html. It is a snapshot of the page at 2024-11-24T22:37:50.865+0000.
TokenReview [authentication.k8s.io/v1] - Authorization <strong>api</strong>s | <strong>api</strong> reference | OKD 4.10
  1. Documentation
×

TokenReview [authentication.k8s.io/v1]

Description

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.

Type

object

Required

  • spec

Specification

Property Type Description

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

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

metadata

ObjectMeta

spec

object

TokenReviewSpec is a description of the token authentication request.

status

object

TokenReviewStatus is the result of the token authentication request.

.spec

Description

TokenReviewSpec is a description of the token authentication request.

Type

object

Property Type Description

audiences

array (string)

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

string

Token is the opaque bearer token.

.status

Description

TokenReviewStatus is the result of the token authentication request.

Type

object

Property Type Description

audiences

array (string)

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

boolean

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

error

string

Error indicates that the token couldn’t be checked

user

object

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

.status.user

Description

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

Type

object

Property Type Description

extra

object

Any additional information provided by the authenticator.

extra{}

array (string)

groups

array (string)

The names of groups this user is a part of.

uid

string

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

string

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

.status.user.extra

Description

Any additional information provided by the authenticator.

Type

object

api endpoints

The following api endpoints are available:

  • /apis/oauth.openshift.io/v1/tokenreviews

    • POST: create a TokenReview

  • /apis/authentication.k8s.io/v1/tokenreviews

    • POST: create a TokenReview

/apis/oauth.openshift.io/v1/tokenreviews

Table 1. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create a TokenReview

Table 2. Body parameters
Parameter Type Description

body

TokenReview_v2 schema
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

TokenReview_v2 schema

201 - Created

TokenReview_v2 schema

202 - Accepted

TokenReview_v2 schema

401 - Unauthorized

Empty

/apis/authentication.k8s.io/v1/tokenreviews

Table 4. Global query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

string

If 'true', then the output is pretty printed.
HTTP method

POST

Description

create a TokenReview

Table 5. Body parameters
Parameter Type Description

body

TokenReview schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

TokenReview schema

201 - Created

TokenReview schema

202 - Accepted

TokenReview schema

401 - Unauthorized

Empty