website/docs/api-reference/v1.5/documents/_generated_tokenreview_v1be...

2.8 KiB


TokenReview v1beta1

Group Version Kind
Authentication v1beta1 TokenReview

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.

Field 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
TokenReviewSpec
Spec holds information about the request being evaluated
status
TokenReviewStatus
Status is filled in by the server and indicates whether the request can be authenticated.

TokenReviewSpec v1beta1

Field Description
token
string
Token is the opaque bearer token.

TokenReviewStatus v1beta1

Field Description
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
UserInfo
User is the UserInfo associated with the provided token.

Write Operations

See supported operations below...

Create

bdocs-tab:kubectl kubectl Command


Coming Soon

bdocs-tab:curl curl Command (requires kubectl proxy to be running)


Coming Soon

bdocs-tab:kubectl Output


Coming Soon

bdocs-tab:curl Response Body


Coming Soon

create a TokenReview

HTTP Request

POST /apis/authentication.k8s.io/v1beta1/tokenreviews

Query Parameters

Parameter Description
pretty If 'true', then the output is pretty printed.

Body Parameters

Parameter Description
body
TokenReview

Response

Code Description
200
TokenReview
OK