機能の有効化と無効化

オプション機能を使用するためのKeycloakの設定方法について説明します。

Keycloakには、テクノロジープレビューや非推奨機能など、いくつかの無効化された機能を含む機能がパッケージ化されています。他の機能はデフォルトで有効になっていますが、Keycloakの使用に適用されない場合は無効にすることができます。

機能の有効化

一部のサポート対象機能とすべてのプレビュー機能は、デフォルトで無効になっています。機能を有効にするには、次のコマンドを入力します。

bin/kc.[sh|bat] build --features="<name>[,<name>]"

たとえば、dockertoken-exchangeを有効にするには、次のコマンドを入力します。

bin/kc.[sh|bat] build --features="docker,token-exchange"

すべてのプレビュー機能を有効にするには、次のコマンドを入力します。

bin/kc.[sh|bat] build --features="preview"

有効化された機能には、バージョン付きまたはバージョンなしがあります。バージョン付きの機能名(例:feature:v1)を使用すると、ランタイムに存在し続ける限り、その正確な機能バージョンが有効になります。代わりにバージョンなしの名前(例:feature)を使用すると、特定のサポート対象機能バージョンの選択は、次の優先順位に従ってリリースごとに変更される可能性があります。

  1. 最も高いデフォルトサポートバージョン

  2. 最も高い非デフォルトサポートバージョン

  3. 最も高い非推奨バージョン

  4. 最も高いプレビューバージョン

  5. 最も高い実験的バージョン

機能の無効化

デフォルトで有効になっている機能を無効にするには、次のコマンドを入力します。

bin/kc.[sh|bat] build --features-disabled="<name>[,<name>]"

たとえば、impersonationを無効にするには、次のコマンドを入力します。

bin/kc.[sh|bat] build --features-disabled="impersonation"

features-disabledリストとfeaturesリストの両方に同じ機能を含めることは許可されていません。

機能が無効になると、その機能のすべてのバージョンが無効になります。

サポート対象機能

次のリストには、デフォルトで有効になっており、必要ない場合は無効にできるサポート対象機能が含まれています。

account-api

アカウント管理REST API

account-v3

アカウントコンソール バージョン3

admin-api

Admin API

admin-fine-grained-authz-v2

きめ細かい管理者権限 バージョン2

admin-v2

新しい管理コンソール

authorization

認可サービス

ciba

OpenID Connect クライアント起動バックチャネル認証(CIBA)

client-policies

クライアント構成ポリシー

device-flow

OAuth 2.0 デバイス認可グラント

hostname-v2

ホスト名オプション V2

impersonation

管理者によるユーザーの偽装機能

kerberos

Kerberos

login-v2

新しいログインテーマ

opentelemetry

OpenTelemetryトレーシング

organization

レルム内の組織サポート

par

OAuth 2.0 プッシュ認可リクエスト(PAR)

persistent-user-sessions

再起動およびアップグレードを跨いでの永続的なオンラインユーザーセッション

rolling-updates-v1

ローリングアップデート

step-up-authentication

ステップアップ認証

token-exchange-standard-v2

標準トークン交換 バージョン2

user-event-metrics

ユーザーイベントに基づいたメトリクスの収集

web-authn

W3C Web認証(WebAuthn)

デフォルトで無効

次のリストには、デフォルトで無効になっており、必要に応じて有効にできるサポート対象機能が含まれています。

docker

Dockerレジストリプロトコル

fips

FIPS 140-2 モード

multi-site

マルチサイトサポート

プレビュー機能

プレビュー機能はデフォルトで無効になっており、本番環境での使用は推奨されません。これらの機能は、将来のリリースで変更または削除される可能性があります。

admin-fine-grained-authz

きめ細かい管理者権限

client-secret-rotation

クライアントシークレットローテーション

dpop

OAuth 2.0 アプリケーション層での所有証明の実証

passkeys

パスキー

recovery-codes

リカバリーコード

scripts

JavaScriptを使用したカスタム認証機能の記述

token-exchange

トークン交換サービス

update-email

メール更新アクション

非推奨機能

次のリストには、将来のリリースで削除される予定の非推奨機能が含まれています。これらの機能はデフォルトで無効になっています。

login-v1

レガシーログインテーマ

関連オプション

features

1つ以上の機能セットを有効にします。

CLI: --features
Env: KC_FEATURES

account-api[:v1], account[:v3], admin-api[:v1], admin-fine-grained-authz[:v1,v2], admin[:v2], authorization[:v1], cache-embedded-remote-store[:v1], ciba[:v1], client-policies[:v1], client-secret-rotation[:v1], client-types[:v1], clusterless[:v1], declarative-ui[:v1], device-flow[:v1], docker[:v1], dpop[:v1], dynamic-scopes[:v1], fips[:v1], hostname[:v2], impersonation[:v1], ipa-tuura-federation[:v1], kerberos[:v1], login[:v2,v1], multi-site[:v1], oid4vc-vci[:v1], opentelemetry[:v1], organization[:v1], par[:v1], passkeys[:v1], persistent-user-sessions[:v1], preview, quick-theme[:v1], recovery-codes[:v1], rolling-updates[:v1], scripts[:v1], step-up-authentication[:v1], token-exchange-standard[:v2], token-exchange[:v1], transient-users[:v1], update-email[:v1], user-event-metrics[:v1], web-authn[:v1]

features-disabled

1つ以上の機能セットを無効にします。

CLI: --features-disabled
Env: KC_FEATURES_DISABLED

account, account-api, admin, admin-api, admin-fine-grained-authz, authorization, cache-embedded-remote-store, ciba, client-policies, client-secret-rotation, client-types, clusterless, declarative-ui, device-flow, docker, dpop, dynamic-scopes, fips, impersonation, ipa-tuura-federation, kerberos, login, multi-site, oid4vc-vci, opentelemetry, organization, par, passkeys, persistent-user-sessions, preview, quick-theme, recovery-codes, rolling-updates, scripts, step-up-authentication, token-exchange, token-exchange-standard, transient-users, update-email, user-event-metrics, web-authn

このページについて