第5章 参照
5.1. elytron-oidc-client サブシステム属性
elytron-oidc-client
サブシステムは、その動作を設定するための属性を提供します。
属性 | 説明 |
---|---|
provider | OpenID Connect プロバイダーの設定。 |
secure-deployment | OpenID Connect プロバイダーによって保護されたデプロイメント。 |
realm |
Red Hat build of Keycloak レルムの設定。これは便宜上提供されています。keycloak クライアントアダプターで設定をコピーして、ここで使用できます。代わりに |
次の目的で、3 つの elytron-oidc-client
属性を使用します。
-
provider
: OpenID Connect プロバイダーを設定します。詳細は、provider
属性 を参照してください。 -
secure-deployment
: OpenID Connect によって保護されたデプロイメントを設定します。詳細は、secure-deployment
属性 を参照してください。 -
realm
: Red Hat build of Keycloak を設定するための属性です。詳細は、realm
属性 を参照してください。realm
の使用は推奨しません。便宜上提供されています。keycloak クライアントアダプターで設定をコピーして、ここで使用できます。代わりに、provider
属性を使用することを推奨します。
属性 | デフォルト値 | 説明 |
---|---|---|
allow-any-hostname |
|
値を |
always-refresh-token |
|
|
auth-server-url |
|
Red Hat build of Keycloak レルム認証サーバーのベース URL。この属性を使用する場合は、
または、 |
autodetect-bearer-only |
| bearer-only リクエストを自動検出するかどうかを設定します。
bearer-only リクエストを受信し、
この属性を使用すると、 |
client-id |
| OpenID プロバイダーに登録された JBoss EAP の client-id。 |
client-key-password |
|
|
client-keystore |
| アプリケーションが HTTPS を介して OpenID プロバイダーと通信する場合は、この属性でクライアントキーストアへのパスを設定します。 |
client-keystore-password |
|
|
confidential-port |
| OpenID プロバイダーが使用する機密ポート (SSL/TLS) を指定します。 |
connection-pool-size |
| OpenID プロバイダーと通信するときに使用する接続プールのサイズを指定します。 |
connection-timeout-millis |
|
リモートホストとの接続を確立するためのタイムアウトをミリ秒単位で指定します。最小値は |
connection-ttl-millis |
|
接続を維持する時間をミリ秒単位で指定します。最小値は |
cors-allowed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-allowed-methods |
| Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより Access-Control-Allow-Methods ヘッダーの値が設定されます。これはコンマ区切りの文字列である必要があります。これは任意です。設定されていない場合、このヘッダーは CORS 応答で返されません。 |
cors-exposed-headers |
| CORS が有効な場合は、Access-Control-Expose-Headers ヘッダーの値を設定します。これはコンマ区切りの文字列である必要があります。これは最適です。設定されていない場合、このヘッダーは CORS 応答で返されません。 |
cors-max-age |
|
Cross-Origin Resource Sharing (CORS) Max-Age ヘッダーの値を設定します。値は |
disable-trust-manager |
| HTTPS 経由で OpenID プロバイダーと通信するときにトラストマネージャーを使用するかどうかを指定します。 |
enable-cors |
| Red Hat build of Keycloak の Cross-Origin Resource Sharing (CORS) のサポートを有効にします。 |
expose-token |
|
|
ignore-oauth-query-parameter |
|
|
principal-attribute |
| アイデンティティーのプリンシパルとして使用する ID トークンのクレーム値を指定します。 |
provider-url |
| OpenID プロバイダーの URL を指定します。 |
proxy-url |
| HTTP プロキシーを使用する場合は、その URL を指定します。 |
realm-public-key |
| レルムの公開鍵を指定します。 |
register-node-at-startup |
|
|
register-node-period |
| ノードを再登録する頻度を指定します。 |
socket-timeout-millis |
| データを待機するソケットのタイムアウトをミリ秒単位で指定します。 |
ssl-required |
| OpenID プロバイダーとの通信を HTTPS 経由で行うかどうかを指定します。値は次のいずれかになります。
|
token-signature-algorithm |
| OpenID プロバイダーが使用するトークン署名アルゴリズムを指定します。サポートされているアルゴリズムは次のとおりです。
|
token-store |
| auth-session データの Cookie またはセッションストレージを指定します。 |
truststore |
| クライアント HTTPS 要求に使用されるトラストストアを指定します。 |
truststore-password |
| トラストストアのパスワードを指定します。 |
verify-token-audience |
|
|
属性 | デフォルト値 | 説明 |
---|---|---|
allow-any-hostname |
|
値を |
always-refresh-token |
|
|
auth-server-url |
|
Red Hat build of Keycloak レルム認可サーバーのベース URL。代わりに |
autodetect-bearer-only |
|
bearer-only リクエストを自動検出するかどうかを設定します。bearer-only リクエストを受信し、 |
bearer-only |
|
Bearer トークン認証でアプリケーションを保護するには、これを |
client-id |
| OpenID プロバイダーに登録されているクライアントの一意の識別子。 |
client-key-password |
|
|
client-keystore |
| アプリケーションが HTTPS を介して OpenID プロバイダーと通信する場合は、この属性でクライアントキーストアへのパスを設定します。 |
client-keystore-password |
|
|
confidential-port |
| OpenID プロバイダーが使用する機密ポート (SSL/TLS) を指定します。 |
connection-pool-size |
| OpenID プロバイダーと通信するときに使用する接続プールのサイズを指定します。 |
connection-timeout-millis |
|
リモートホストとの接続を確立するためのタイムアウトをミリ秒単位で指定します。最小値は |
connection-ttl-millis |
|
接続を維持する時間をミリ秒単位で指定します。最小値は |
cors-allowed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-allowed-methods |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-exposed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-max-age |
|
Cross-Origin Resource Sharing (CORS) Max-Age ヘッダーの値を設定します。値は |
credential |
| OpenID プロバイダーとの通信に使用する認証情報を指定します。 |
disable-trust-manager |
| HTTPS 経由で OpenID プロバイダーと通信するときにトラストマネージャーを使用するかどうかを指定します。 |
enable-cors |
| Red Hat build of Keycloak の Cross-Origin Resource Sharing (CORS) のサポートを有効にします。 |
enable-basic-auth |
| Basic 認証を有効にして、bearer トークンの取得に使用する認証情報を指定します。 |
expose-token |
|
|
ignore-oauth-query-parameter |
|
|
min-time-between-jwks-requests |
サブシステムが不明な公開鍵によって署名されたトークンを検出した場合、JBoss EAP は | principal-attribute |
| アイデンティティーのプリンシパルとして使用する ID トークンのクレーム値を指定します。 | provider |
| OpenID プロバイダーを指定します。 | provider-url |
| OpenID プロバイダーの URL を指定します。 | proxy-url |
| HTTP プロキシーを使用する場合は、その URL を指定します。 | public-client |
|
| realm |
| Red Hat build of Keycloak での接続に使用するレルム。 | realm-public-key |
| OpenID プロバイダーの公開鍵を PEM 形式で指定します。 | redirect-rewrite-rule |
| リダイレクト URI に適用する書き換えルールを指定します。 | register-node-at-startup |
|
| register-node-period |
| ノードを再登録する頻度を秒単位で指定します。 | resource |
|
OIDC で保護するアプリケーションの名前を指定します。または、 | socket-timeout-millis |
| データを待機するソケットのタイムアウトをミリ秒単位で指定します。 | ssl-required |
| OpenID プロバイダーとの通信を HTTPS 経由で行うかどうかを指定します。値は次のいずれかになります。
| token-minimum-time-to-live |
| 現在のトークンが期限切れになるか、秒単位で設定した時間内に期限切れになる場合、アダプターはトークンを更新します。 | token-signature-algorithm |
| OpenID プロバイダーが使用するトークン署名アルゴリズムを指定します。サポートされているアルゴリズムは次のとおりです。
| token-store |
| auth-session データの Cookie またはセッションストレージを指定します。 | truststore |
| アダプタークライアントの HTTPS 要求に使用されるトラストストアを指定します。 | truststore-password |
| トラストストアのパスワードを指定します。 | turn-off-change-session-id-on-login |
|
ログインに成功すると、デフォルトでセッション ID が変更されます。これをオフにするには、値を | use-resource-role-mappings |
| トークンから取得したリソースレベルの権限を使用します。 | verify-token-audience |
属性 | デフォルト値 | 説明 |
---|---|---|
adapter-state-cookie-path |
|
この属性は、設定されている場合、サブシステムによって設定される Cookie で使用されるパスを定義します。設定されていない場合、 |
allow-any-hostname |
|
値を |
always-refresh-token |
|
|
auth-server-url-for-backend-requests |
| ロードバランサーやリバースプロキシーを経由せずに OpenID プロバイダーを直接呼び出すバックエンドリクエストにのみ使用する URL を指定します。 |
auth-server-url |
|
Red Hat build of Keycloak レルム認可サーバーのベース URL。代わりに |
autodetect-bearer-only |
| bearer-only リクエストを自動検出するかどうかを設定します。
bearer-only リクエストを受信し、
この属性を使用すると、 |
bearer-only |
|
Bearer トークン認証でアプリケーションを保護するには、これを
Bearer トークン認証が有効になっている場合、ユーザーはログインするために OpenID プロバイダーにリダイレクトされません。代わりに、 |
client-id |
| OpenID プロバイダーに登録されているクライアントの一意の識別子。 |
client-key-password |
|
|
client-keystore-password |
|
|
client-keystore |
| HTTPS で OpenID プロバイダーと通信する場合は、この属性にクライアントキーストアへのパスを設定します。 |
confidential-port |
| OpenID プロバイダーが使用する機密ポート (SSL/TLS) を指定します。 |
connection-pool-size |
| OpenID プロバイダーと通信するときに使用する接続プールのサイズを指定します。 |
connection-timeout-millis |
|
リモートホストとの接続を確立するためのタイムアウトをミリ秒単位で指定します。最小値は |
connection-ttl-millis |
|
接続を維持する時間をミリ秒単位で指定します。最小値は |
cors-allowed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-allowed-methods |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-exposed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-max-age |
|
Cross-Origin Resource Sharing (CORS) Max-Age ヘッダーの値を設定します。値は |
credential |
| OpenID プロバイダーとの通信に使用する認証情報を指定します。 |
disable-trust-manager |
| HTTPS 経由で OpenID プロバイダーと通信するときにトラストマネージャーを使用するかどうかを指定します。 |
enable-basic-auth |
| Basic 認証を有効にして、bearer トークンの取得に使用する認証情報を指定します。 |
enable-cors |
| Red Hat build of Keycloak の Cross-Origin Resource Sharing (CORS) のサポートを有効にします。 |
expose-token |
|
|
ignore-oauth-query-parameter |
|
|
min-time-between-jwks-requests |
|
サブシステムが不明な公開鍵によって署名されたトークンを検出した場合、JBoss EAP は |
principal-attribute |
| アイデンティティーのプリンシパルとして使用する ID トークンのクレーム値を指定します。 |
principal-attribute |
| アイデンティティーのプリンシパルとして使用する ID トークンのクレーム値を指定します。 |
provider |
| OpenID プロバイダーを指定します。 |
provider-url |
| OpenID プロバイダーの URL を指定します。 |
proxy-url |
| HTTP プロキシーを使用する場合は、その URL を指定します。 |
public-client |
|
|
public-key-cache-ttl |
| 新しい公開鍵を取得する 2 つのリクエスト間の最大間隔 (秒単位)。 |
realm-public-key |
| OpenID プロバイダーの公開鍵を PEM 形式で指定します。 |
realm |
| Red Hat build of Keycloak での接続に使用するレルム。 |
redirect-rewrite-rule |
| リダイレクト URI に適用する書き換えルールを指定します。 |
register-node-at-startup |
|
|
register-node-period |
| ノードを再登録する頻度を秒単位で指定します。 |
resource |
|
OIDC で保護するアプリケーションの名前を指定します。または、 |
socket-timeout-millis |
| データを待機するソケットのタイムアウトをミリ秒単位で指定します。 |
ssl-required |
| OpenID プロバイダーとの通信を HTTPS 経由で行うかどうかを指定します。値は次のいずれかになります。
|
token-minimum-time-to-live |
| 現在のトークンが期限切れになるか、秒単位で設定した時間内に期限切れになる場合、アダプターはトークンを更新します。 |
token-signature-algorithm |
| OpenID プロバイダーが使用するトークン署名アルゴリズムを指定します。サポートされているアルゴリズムは次のとおりです。
|
token-store |
| auth-session データの Cookie またはセッションストレージを指定します。 |
truststore-password |
| トラストストアのパスワードを指定します。 |
truststore |
| アダプタークライアントの HTTPS 要求に使用されるトラストストアを指定します。 |
turn-off-change-session-id-on-login |
|
ログインに成功すると、デフォルトでセッション ID が変更されます。これをオフにするには、値を |
use-resource-role-mappings |
| トークンから取得したリソースレベルの権限を使用します。 |
verify-token-audience |
|
|
属性 | デフォルト値 | 説明 |
---|---|---|
allow-any-hostname |
|
値を |
always-refresh-token |
|
|
auth-server-url |
|
Red Hat build of Keycloak レルム認可サーバーのベース URL。代わりに |
autodetect-bearer-only |
|
bearer-only リクエストを自動検出するかどうかを設定します。bearer-only リクエストを受信し、 |
client-key-password |
|
|
client-keystore |
| アプリケーションが HTTPS を介して OpenID プロバイダーと通信する場合は、この属性でクライアントキーストアへのパスを設定します。 |
client-keystore-password |
|
|
confidential-port |
| Red Hat build of Keycloak が使用する機密ポート (SSL/TLS) を指定します。 |
connection-pool-size |
| Red Hat build of Keycloak と通信するときに使用する接続プールのサイズを指定します。 |
connection-timeout-millis |
|
リモートホストとの接続を確立するためのタイムアウトをミリ秒単位で指定します。最小値は |
connection-ttl-millis |
|
接続を維持する時間をミリ秒単位で指定します。最小値は |
cors-allowed-headers |
| Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより Access-Control-Allow-Headers ヘッダーの値が設定されます。これはコンマ区切りの文字列である必要があります。これは任意です。設定されていない場合、このヘッダーは CORS 応答で返されません。 |
cors-allowed-methods |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-exposed-headers |
|
Cross-Origin Resource Sharing (CORS) が有効になっている場合、これにより |
cors-max-age |
|
Cross-Origin Resource Sharing (CORS) Max-Age ヘッダーの値を設定します。値は |
disable-trust-manager |
| HTTPS 経由で OpenID プロバイダーと通信するときにトラストマネージャーを使用するかどうかを指定します。 |
enable-cors |
| Red Hat build of Keycloak の Cross-Origin Resource Sharing (CORS) のサポートを有効にします。 |
expose-token |
|
|
ignore-oauth-query-parameter |
|
|
principal-attribute |
| アイデンティティーのプリンシパルとして使用する ID トークンのクレーム値を指定します。 |
provider-url |
| OpenID プロバイダーの URL を指定します。 |
proxy-url |
| HTTP プロキシーを使用する場合は、その URL を指定します。 |
realm-public-key |
| レルムの公開鍵を指定します。 |
register-node-at-startup |
|
|
register-node-period |
| ノードを再登録する頻度を指定します。 |
socket-timeout-millis |
| データを待機するソケットのタイムアウトをミリ秒単位で指定します。 |
ssl-required |
| OpenID プロバイダーとの通信を HTTPS 経由で行うかどうかを指定します。値は次のいずれかになります。
|
token-signature-algorithm |
| OpenID プロバイダーが使用するトークン署名アルゴリズムを指定します。サポートされているアルゴリズムは次のとおりです。
|
token-store |
| auth-session データの Cookie またはセッションストレージを指定します。 |
truststore |
| クライアント HTTPS 要求に使用されるトラストストアを指定します。 |
truststore-password |
| トラストストアのパスワードを指定します。 |
verify-token-audience |
|
|