啟用和停用功能

了解如何設定 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

管理 API

admin-v2

新的管理控制台

authorization

授權服務

ciba

OpenID Connect 用戶端發起的後端通道身份驗證 (CIBA)

client-policies

用戶端組態原則

device-flow

OAuth 2.0 裝置授權許可

hostname-v2

主機名稱選項 V2

impersonation

管理員模擬使用者身分的能力

kerberos

Kerberos

login-v2

新的登入主題

organization

領域內的組織支援

par

OAuth 2.0 推送授權請求 (PAR)

persistent-user-sessions

跨重新啟動和升級的持久線上用戶會話

step-up-authentication

逐步驗證

web-authn

W3C Web 驗證 (WebAuthn)

預設停用

以下列表包含預設為停用的受支援功能,如果需要,可以啟用。

docker

Docker 登錄協定

fips

FIPS 140-2 模式

multi-site

多站點支援

預覽功能

預覽功能預設為停用,不建議在生產環境中使用。這些功能可能會在未來的版本中變更或移除。

admin-fine-grained-authz

細粒度的管理員權限

client-secret-rotation

用戶端密碼輪換

dpop

OAuth 2.0 在應用層展示擁有權證明

opentelemetry

OpenTelemetry 追蹤

passkeys

通行金鑰

recovery-codes

復原碼

scripts

使用 JavaScript 撰寫自訂驗證器

token-exchange

Token 交換服務

update-email

更新電子郵件動作

已棄用的功能

以下列表包含將在未來版本中移除的已棄用功能。這些功能預設為停用。

login-v1

舊版登入主題

相關選項

features

啟用一或多個功能。

CLI: --features
Env: KC_FEATURES

account-api[:v1]account[:v3]admin-api[:v1]admin-fine-grained-authz[:v1]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]kerberos[:v1]login[:v2,v1]multi-site[:v1]oid4vc-vci[:v1]opentelemetry[:v1]organization[:v1]par[:v1]passkeys[:v1]persistent-user-sessions[:v1]previewrecovery-codes[:v1]scripts[:v1]step-up-authentication[:v1]token-exchange[:v1]transient-users[:v1]update-email[:v1]web-authn[:v1]

features-disabled

停用一或多個功能。

CLI: --features-disabled
Env: KC_FEATURES_DISABLED

accountaccount-apiadminadmin-apiadmin-fine-grained-authzauthorizationcache-embedded-remote-storecibaclient-policiesclient-secret-rotationclient-typesclusterlessdeclarative-uidevice-flowdockerdpopdynamic-scopesfipsimpersonationkerberosloginmulti-siteoid4vc-vciopentelemetryorganizationparpasskeyspersistent-user-sessionspreviewrecovery-codesscriptsstep-up-authenticationtoken-exchangetransient-usersupdate-emailweb-authn

本頁內容