TokenReview [authentication.k8s.io/v1]

    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

    Required

    • spec

    Description

    TokenReviewSpec is a description of the token authentication request.

    Type

    object

    PropertyTypeDescription

    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

    PropertyTypeDescription

    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

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

    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.

    Description

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

    Type

    object

    .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
    Table 1. Global query parameters
    ParameterTypeDescription

    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 .

    pretty

    string

    If ‘true’, then the output is pretty printed.

    POST

    Description

    create a TokenReview

    Table 2. Body parameters
    ParameterTypeDescription

    body

    TokenReview schema

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

    Table 4. Global query parameters
    ParameterTypeDescription

    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.

    fieldValidation

    string

    fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the ServerSideFieldValidation feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the ServerSideFieldValidation feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the ServerSideFieldValidation feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    Description

    create a TokenReview

    Table 5. Body parameters
    ParameterTypeDescription

    body

    schema