第5章 OAuthClient [oauth.openshift.io/v1]
- 説明
OAuthClient は OAuth クライアントを説明します
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- タイプ
-
object
5.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| AccessTokenInactivityTimeoutSeconds は、このクライアントに付与されたトークンのデフォルトのトークン非アクティブタイムアウトをオーバーライドします。この値は、トークンを連続して使用する間に発生する可能性のある最大時間を表します。トークンがこの一時ウィンドウ内で使用されない場合、トークンは無効になります。トークンがタイムアウトしたときにアクセスを回復するには、ユーザーは新しいトークンを取得する必要があります。この値を設定する必要があるのは、設定で設定されているデフォルトがこのクライアントに適していない場合のみです。有効な値は次のとおりです。-0: このクライアントのトークンはタイムアウトしません -X:X 秒間アクティビティーがない場合、トークンはタイムアウトします X の現在の最小許容値は 300(5 分) です 警告: この値を変更しても、既存のトークンのタイムアウトは影響を受けません (低下します)。 |
|
| AccessTokenMaxAgeSeconds は、このクライアントに付与されたトークンのデフォルトのアクセストークンの最大経過時間を上書きします。0 は有効期限がないことを意味します。 |
|
| AdditionalSecrets は、クライアントを識別するために使用される可能性のある他のシークレットを保持します。これは、ローテーションやサービスアカウントトークンの検証に役立ちます |
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| GrantMethod は、このクライアントの許可を処理する方法を決定する必須フィールドです。有効な許可処理方法は次のとおりです。--auto: 常に許可要求を承認します。信頼できるクライアントに役立ちます。--prompt: エンドユーザーに許可要求の承認を求めます。サードパーティーのクライアントに役立ちます。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| RedirectURIs は、クライアントに関連付けられた有効なリダイレクト URI です。 |
|
| RespondWithChallenges は、クライアントがリダイレクトではなくチャレンジの形で行われる認証に必要な応答を望んでいるかどうかを示します |
|
| ScopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致する場合、スコープは許可されます。一致する制限がない場合、スコープは拒否されます。 |
|
| ScopeRestriction は、スコープに対する 1 つの制限を記述します。正確に 1 つのオプションは nil 以外でなければなりません。 |
|
| シークレットは、クライアントに関連付けられた一意のシークレットです |
5.1.1. .scopeRestrictions
- 説明
- ScopeRestrictions は、このクライアントが要求できるスコープを記述します。要求された各スコープは、各制限に対してチェックされます。いずれかの制限が一致する場合、スコープは許可されます。一致する制限がない場合、スコープは拒否されます。
- タイプ
-
array
5.1.2. .scopeRestrictions[]
- 説明
- ScopeRestriction は、スコープに対する 1 つの制限を記述します。正確に 1 つのオプションは nil 以外でなければなりません。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明します |
|
| ExactValues は、スコープが特定の文字列セットと正確に一致する必要があることを意味します |
5.1.3. .scopeRestrictions[].clusterRole
- 説明
- ClusterRoleScopeRestriction は、クラスターロールスコープの制限を説明します
- タイプ
-
object
- 必須
-
roleNames
-
namespace
-
allowEscalation
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| AllowEscalation は、ロールとそのエスカレートするリソースをリクエストできるかどうかを示します |
|
| 名前空間は、参照できる名前空間のリストです。*はそれらのいずれかを意味します (*を含む) |
|
| RoleNames は、参照できるクラスターロールのリストです。*は何でも意味します |