9.3.4. OAuth 設定フィールド
以下のフィールドは、OAuth を使用して外部アイデンティティープロバイダーを通じて認証を処理する場合の Red Hat Quay の動作を定義します。トークンの割り当てやホワイトリストに登録されたクライアント ID などのグローバル OAuth オプション、および GitHub と Google のプロバイダー固有の設定を行うことができます。
| フィールド | 型 | 説明 |
|---|---|---|
| DIRECT_OAUTH_CLIENTID_WHITELIST | 文字列の配列 | ユーザーの承認なしに直接 OAuth 承認を実行できる Quay 管理 アプリケーションのクライアント ID のリスト。 |
| FEATURE_ASSIGN_OAUTH_TOKEN | Boolean | 組織管理者が他のユーザーに OAuth トークンを割り当てることを許可します。 |
グローバル OAuth の YAML サンプル
# ...
DIRECT_OAUTH_CLIENTID_WHITELIST:
- <quay_robot_client>
- <quay_app_token_issuer>
FEATURE_ASSIGN_OAUTH_TOKEN: true
# ...
関連情報
| フィールド | 型 | 説明 |
|---|---|---|
| FEATURE_GITHUB_LOGIN | Boolean |
GitHub ログインがサポートされるかどうか |
| GITHUB_LOGIN_CONFIG | Object | 外部ログインプロバイダーとして GitHub (Enterprise) を使用するための設定。 |
| .ALLOWED_ORGANIZATIONS | 文字列の配列 | ORG_RESTRICT オプションを使用するためにホワイトリスト化された GitHub (Enterprise) 組織の名前。 |
| .API_ENDPOINT | 文字列 |
使用する GitHub (Enterprise) API のエンドポイント。github.com に対して上書きする必要があります。 |
|
.CLIENT_ID | 文字列 |
この Red Hat Quay インスタンスに登録されているクライアント ID は、 |
|
.CLIENT_SECRET | 文字列 |
この Red Hat Quay インスタンスに登録されているクライアントシークレット。 |
|
.GITHUB_ENDPOINT | 文字列 |
GitHub (Enterprise) のエンドポイント。 |
| .ORG_RESTRICT | Boolean | true の場合は、組織のホワイトリスト内のユーザーのみが、このプロバイダーを使用してログインできます。 |
Github OAth の YAML サンプル
# ...
FEATURE_GITHUB_LOGIN: true
GITHUB_LOGIN_CONFIG:
ALLOWED_ORGANIZATIONS:
- <myorg>
- <dev-team>
API_ENDPOINT: <https://api.github.com/>
CLIENT_ID: <client_id>
CLIENT_SECRET: <client_secret>
GITHUB_ENDPOINT: <https://github.com/>
ORG_RESTRICT: true
# ...
| フィールド | 型 | 説明 |
|---|---|---|
| FEATURE_GOOGLE_LOGIN | Boolean |
Google ログインがサポートされているかどうか。 |
| GOOGLE_LOGIN_CONFIG | Object | 外部認証に Google を使用するための設定。 |
|
.CLIENT_ID | 文字列 |
この Red Hat Quay インスタンスに登録されているクライアント ID。 |
|
.CLIENT_SECRET | 文字列 |
この Red Hat Quay インスタンスに登録されているクライアントシークレット。 |
Google OAuth の YAML サンプル
# ...
FEATURE_GOOGLE_LOGIN: true
GOOGLE_LOGIN_CONFIG:
CLIENT_ID: <client_id>
CLIENT_SECRET: <client_secret>
# ...