Rechercher

Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 8. Authentication APIs

download PDF

8.1. Authentication APIs

8.1.1. TokenRequest [authentication.k8s.io/v1]

Description
TokenRequest requests a token for a given service account.
Type
object

8.1.2. TokenReview [authentication.k8s.io/v1]

Description
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.
Type
object

8.2. TokenRequest [authentication.k8s.io/v1]

Description
TokenRequest requests a token for a given service account.
Type
object
Required
  • spec

8.2.1. Specification

PropertyTypeDescription

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.

8.2.1.1. .spec

Description
TokenRequestSpec contains client provided parameters of a token request.
Type
object
Required
  • audiences
PropertyTypeDescription

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.

8.2.1.2. .spec.boundObjectRef

Description
BoundObjectReference is a reference to an object that a token is bound to.
Type
object
PropertyTypeDescription

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.

8.2.1.3. .status

Description
TokenRequestStatus is the result of a token request.
Type
object
Required
  • token
  • expirationTimestamp
PropertyTypeDescription

expirationTimestamp

Time

ExpirationTimestamp is the time of expiration of the returned token.

token

string

Token is the opaque bearer token.

8.2.2. API endpoints

The following API endpoints are available:

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

    • POST: create token of a ServiceAccount

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

Table 8.1. Global path parameters
ParameterTypeDescription

name

string

name of the TokenRequest

namespace

string

object name and auth scope, such as for teams and projects

Table 8.2. Global query parameters
ParameterTypeDescription

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 'true', then the output is pretty printed.

HTTP method
POST
Description
create token of a ServiceAccount
Table 8.3. Body parameters
ParameterTypeDescription

body

TokenRequest schema

 
Table 8.4. HTTP responses
HTTP codeReponse body

200 - OK

TokenRequest schema

201 - Created

TokenRequest schema

202 - Accepted

TokenRequest schema

401 - Unauthorized

Empty

8.3. TokenReview [authentication.k8s.io/v1]

Description
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.
Type
object
Required
  • spec

8.3.1. Specification

PropertyTypeDescription

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

TokenReviewSpec is a description of the token authentication request.

status

object

TokenReviewStatus is the result of the token authentication request.

8.3.1.1. .spec

Description
TokenReviewSpec is a description of the token authentication request.
Type
object
PropertyTypeDescription

audiences

array (string)

Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver.

token

string

Token is the opaque bearer token.

8.3.1.2. .status

Description
TokenReviewStatus is the result of the token authentication request.
Type
object
PropertyTypeDescription

audiences

array (string)

Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token’s audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server.

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

object

UserInfo holds the information about the user needed to implement the user.Info interface.

8.3.1.3. .status.user

Description
UserInfo holds the information about the user needed to implement the user.Info interface.
Type
object
PropertyTypeDescription

extra

object

Any additional information provided by the authenticator.

extra{}

array (string)

 

groups

array (string)

The names of groups this user is a part of.

uid

string

A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.

username

string

The name that uniquely identifies this user among all active users.

8.3.1.4. .status.user.extra

Description
Any additional information provided by the authenticator.
Type
object

8.3.2. API endpoints

The following API endpoints are available:

  • /apis/authentication.k8s.io/v1/tokenreviews

    • POST: create a TokenReview

8.3.2.1. /apis/authentication.k8s.io/v1/tokenreviews

Table 8.5. Global query parameters
ParameterTypeDescription

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 'true', then the output is pretty printed.

HTTP method
POST
Description
create a TokenReview
Table 8.6. Body parameters
ParameterTypeDescription

body

TokenReview schema

 
Table 8.7. HTTP responses
HTTP codeReponse body

200 - OK

TokenReview schema

201 - Created

TokenReview schema

202 - Accepted

TokenReview schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez leBlog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

© 2024 Red Hat, Inc.