// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="tokenrequest-authentication-k8s-io-v1"]
= TokenRequest [authentication.k8s.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
TokenRequest requests a token for a given service account.
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| 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`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`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`



[cols="1,1,1",options="header"]
|===
| 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`




[cols="1,1,1",options="header"]
|===
| 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`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `expirationTimestamp`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`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

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the TokenRequest
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols="1,1,2",options="header"]
|===
| 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.
| `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.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
|===

HTTP method::
  `POST`

Description::
  create token of a ServiceAccount



.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../authentication_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema
|
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../authentication_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema
| 201 - Created
| xref:../authentication_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema
| 202 - Accepted
| xref:../authentication_apis/tokenrequest-authentication-k8s-io-v1.adoc#tokenrequest-authentication-k8s-io-v1[`TokenRequest`] schema
| 401 - Unauthorized
| Empty
|===


