TokenRequest [authentication.k8s.io/v1]
Description
TokenRequest requests a token for a given service account.
Type
object
Required
spec
Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
| TokenRequestSpec contains client provided parameters of a token request. |
|
| 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 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. |
|
| BoundObjectReference is a reference to an object that a token is bound to. |
|
| 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 |
---|---|---|
|
| API version of the referent. |
|
| Kind of the referent. Valid kinds are ‘Pod’ and ‘Secret’. |
|
| Name of the referent. |
|
| UID of the referent. |
.status
Description
TokenRequestStatus is the result of a token request.
Type
object
Required
token
expirationTimestamp
Property | Type | Description |
---|---|---|
| ExpirationTimestamp is the time of expiration of the returned token. | |
|
| 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
Parameter | Type | Description |
---|---|---|
|
| name of the TokenRequest |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| 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 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. |
|
| If ‘true’, then the output is pretty printed. |
HTTP method
POST
Description
create token of a ServiceAccount
Parameter | Type | Description |
---|---|---|
| TokenRequest schema |
HTTP code | Reponse body |
---|---|
200 - OK | TokenRequest schema |
201 - Created | TokenRequest schema |
202 - Accepted | TokenRequest schema |
401 - Unauthorized | Empty |