This is a cache of https://docs.okd.io/latest/rest_api/authorization_apis/tokenrequest-authentication-k8s-io-v1.html. It is a snapshot of the page at 2024-11-26T19:34:23.429+0000.
TokenRequest [authentication.k8s.io/v1] - Authorization <strong>api</strong>s | <strong>api</strong> reference | OKD 4
  1. Documentation
×

TokenRequest [authentication.k8s.io/v1]

Description

TokenRequest requests a token for a given service account.

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

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

TokenRequestSpec contains client provided parameters of a token request.

status

object

TokenRequestStatus is the result of a token request.

.spec

Description

TokenRequestSpec contains client provided parameters of a token request.

Type

object

Required

  • audiences

Property Type Description

audiences

array (string)

Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences.

boundObjectRef

object

BoundObjectReference is a reference to an object that a token is bound to.

expirationSeconds

integer

ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response.

.spec.boundObjectRef

Description

BoundObjectReference is a reference to an object that a token is bound to.

Type

object

Property Type Description

apiVersion

string

api version of the referent.

kind

string

Kind of the referent. Valid kinds are 'Pod' and 'Secret'.

name

string

Name of the referent.

uid

string

UID of the referent.

.status

Description

TokenRequestStatus is the result of a token request.

Type

object

Required

  • token

  • expirationTimestamp

Property Type Description

expirationTimestamp

Time

ExpirationTimestamp is the time of expiration of the returned token.

token

string

Token is the opaque bearer token.

api endpoints

The following api endpoints are available:

  • /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token

    • POST: create token of a ServiceAccount

/api/v1/namespaces/{namespace}/serviceaccounts/{name}/token

Table 1. Global path parameters
Parameter Type Description

name

string

name of the TokenRequest
Table 2. 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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. 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. - 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 in v1.23+ - 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.
HTTP method

POST

Description

create token of a ServiceAccount

Table 3. Body parameters
Parameter Type Description

body

TokenRequest schema
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

TokenRequest schema

201 - Created

TokenRequest schema

202 - Accepted

TokenRequest schema

401 - Unauthorized

Empty