8.3. TokenReview [authentication.k8s.io/v1]
- 説明
- TokenReview は、既知のユーザーに対してトークンを認証します。注: TokenReview 要求は、kube-apiserver の webhook トークンオーセンティケータープラグインによってキャッシュされる場合があります。
- タイプ
-
object - 必須
-
spec
-
8.3.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。更新はできません。キャメルケースを使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| TokenReviewSpec は、トークン認証リクエストの説明です。 |
|
|
| TokenReviewStatus は、トークン認証リクエストの結果です。 |
8.3.1.1. .spec
- 説明
- TokenReviewSpec は、トークン認証リクエストの説明です。
- タイプ
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| オーディエンスは、トークンとともに提示されたリソースサーバーが識別する識別子のリストです。オーディエンス対応のトークンオーセンティケーターは、トークンがこのリストの少なくとも 1 人のオーディエンスを対象としていることを確認します。オーディエンスが提供されていない場合、オーディエンスはデフォルトで Kubernetesapiserver のオーディエンスになります。 |
|
|
| トークンは不透明なベアラトークンです。 |
8.3.1.2. .status
- 説明
- TokenReviewStatus は、トークン認証リクエストの結果です。
- タイプ
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| オーディエンスは、TokenReview とトークンの両方と互換性のあるオーセンティケーターによって選択されたオーディエンス識別子です。識別子は、TokenReviewSpec オーディエンスとトークンのオーディエンスの共通部分にある識別子です。spec.audiences フィールドを設定する TokenReview API のクライアントは、互換性のあるオーディエンス識別子が status.audiences フィールドに返されることを検証して、TokenReview サーバーがオーディエンスを認識していることを確認する必要があります。TokenReview が status.authenticated が true である空の status.audience フィールドを返す場合、トークンは KubernetesAPI サーバーのオーディエンスに対して有効です。 |
|
|
| Authenticated は、トークンが既知のユーザーに関連付けられていることを示します。 |
|
|
| エラーは、トークンをチェックできなかったことを示します |
|
|
| UserInfo は、user.Info インターフェイスを実装するために必要なユーザーに関する情報を保持します。 |
8.3.1.3. .status.user
- 説明
- UserInfo は、user.Info インターフェイスを実装するために必要なユーザーに関する情報を保持します。
- タイプ
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| オーセンティケーターによって提供される追加情報。 |
|
|
| |
|
|
| このユーザーが参加しているグループの名前。 |
|
|
| 時間の経過とともにこのユーザーを識別する一意の値。このユーザーが削除され、同じ名前の別のユーザーが追加された場合、それらの UID は異なります。 |
|
|
| すべてのアクティブユーザーの中でこのユーザーを一意に識別する名前。 |
8.3.1.4. .status.user.extra
- 説明
- オーセンティケーターによって提供される追加情報。
- タイプ
-
object
8.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authentication.k8s.io/v1/tokenreviews-
POST:TokenReview を作成します
-
8.3.2.1. /apis/authentication.k8s.io/v1/tokenreviews
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
|
| true の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST - 説明
- TokenReview を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
