TokenRequest [authentication.k8s.io/v1] - Authorization APIs | API reference

Specification
API endpoints
- /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token

Description

TokenRequest requests a token for a given service account.

Type

object

Required

spec

Specification

Property Type Description

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.

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

Property	Type	Description
`audiences`	`array (string)`	Audiences are the intendend audiences of the token. A recipient of a token must identitfy 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.

audiences

array (string)

Audiences are the intendend audiences of the token. A recipient of a token must identitfy 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

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.

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

Property	Type	Description
`expirationTimestamp`	`Time`	ExpirationTimestamp is the time of expiration of the returned token.
`token`	`string`	Token is the opaque bearer token.

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
`namespace`	`string`	object name and auth scope, such as for teams and projects

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
`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 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