8.2. TokenRequest [authentication.k8s.io/v1]
- 説明
- TokenRequest は、指定のサービスアカウントのトークンを要求します。
- タイプ
-
object
- 必須
-
spec
-
8.2.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 を参照してください。 | |
|
| TokenRequestSpec には、トークンリクエストのクライアント提供パラメーターが含まれています。 |
|
| TokenRequestStatus は、トークンリクエストの結果です。 |
8.2.1.1. .spec
- 説明
- TokenRequestSpec には、トークンリクエストのクライアント提供パラメーターが含まれています。
- タイプ
-
object
- 必須
-
audiences
-
プロパティー | 型 | 説明 |
---|---|---|
|
| audiences は、トークンのオーディエンスです。トークンの受信者は、トークンのオーディエンスリストにある識別子を使用して自分自身を識別する必要があり、そうでない場合はトークンを拒否する必要があります。複数のオーディエンスに対して発行されたトークンは、リストされているオーディエンスのいずれかに対して認証するために使用できますが、ターゲットオーディエンス間の高度な信頼を意味します。 |
|
| BoundObjectReference は、トークンがバインドされているオブジェクトへの参照です。 |
|
| ExpirationSeconds は、リクエストされた要求の有効期間です。トークン発行者は、有効期間が異なるトークンを返す可能性があるため、クライアントは応答の有効期限フィールドを確認する必要があります。 |
8.2.1.2. .spec.boundObjectRef
- 説明
- BoundObjectReference は、トークンがバインドされているオブジェクトへの参照です。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| 参照先の種類。有効な種類は Pod とシークレットです。 |
|
| 参照先の名前。 |
|
| 参照先の UID。 |
8.2.1.3. .status
- 説明
- TokenRequestStatus は、トークンリクエストの結果です。
- タイプ
-
object
- 必須
-
token
-
expirationTimestamp
-
プロパティー | 型 | 説明 |
---|---|---|
| ExpirationTimestamp は、返されたトークンの有効期限です。 | |
|
| トークンは不透明なベアラトークンです。 |
8.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
-
POST
:ServiceAccount のトークンを作成します
-
8.2.2.1. /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
パラメーター | 型 | 説明 |
---|---|---|
|
| TokenRequest の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。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
- 説明
- ServiceAccount のトークンを作成します
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | 応答本文 |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |