id
Panduan
Server
Mengaktifkan dan menonaktifkan fitur
idGuidesServerFeatures

Enabling and disabling features

NQRust-Identity menyertakan beberapa fungsi dalam fitur, termasuk beberapa fitur yang dinonaktifkan, seperti Technology Preview dan fitur yang usang. Fitur lainnya diaktifkan secara default, tetapi Anda dapat menonaktifkannya jika tidak berlaku untuk penggunaan NQRust-Identity Anda.

Mengaktifkan fitur

Beberapa fitur yang didukung, dan semua fitur preview, dinonaktifkan secara default. Anda dapat mengaktifkan fitur melalui opsi tunggal atau dengan memasukkannya ke dalam daftar fitur yang diaktifkan.

Opsi tunggal

Anda dapat mengaktifkan fitur spesifik <name> sebagai berikut:

bin/kc.[sh|bat] build --feature-<name>=enabled|disabled|vX

Nilai yang mungkin adalah enabled, disabled, atau versi spesifik fitur yang harus diaktifkan. Sebagai contoh, untuk mengaktifkan token-exchange, masukkan perintah ini:

bin/kc.[sh|bat] build --feature-token-exchange=enabled

Mekanisme opsi tunggal berguna saat memperbarui daftar fitur panjang menjadi sulit atau saat Anda ingin memodifikasi fitur tertentu tanpa menimpa seluruh daftar di dalam image yang sudah dibangun.

Daftar fitur yang diaktifkan

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

Sebagai contoh, untuk mengaktifkan docker dan token-exchange, masukkan perintah ini:

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

Untuk mengaktifkan semua fitur preview, masukkan perintah ini:

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

Penggunaan versi

Fitur yang diaktifkan mungkin memiliki versi, atau tidak memiliki versi. Jika Anda menggunakan nama fitur yang memiliki versi, misalnya fitur:v1, versi fitur tersebut akan diaktifkan selama masih ada di runtime. Jika Anda menggunakan nama tanpa versi, misalnya hanya fitur, pemilihan versi fitur yang didukung tertentu mungkin berubah dari rilis ke rilis sesuai prioritas berikut:

  1. Versi default tertinggi yang didukung
  2. Versi non-default tertinggi yang didukung
  3. Versi usang tertinggi
  4. Versi preview tertinggi
  5. Versi eksperimental tertinggi

Menonaktifkan fitur

Untuk menonaktifkan fitur yang diaktifkan secara default, Anda dapat menggunakan opsi tunggal atau daftar fitur yang dinonaktifkan. Ketika fitur dinonaktifkan, semua versi dari fitur tersebut dinonaktifkan.

Opsi tunggal

Anda dapat menonaktifkan fitur spesifik <name> sebagai berikut:

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

Sebagai contoh, untuk menonaktifkan dpop dan recovery-codes, masukkan perintah ini:

bin/kc.[sh|bat] build --feature-dpop=disabled --feature-recovery-codes=disabled

Mekanisme opsi tunggal berguna saat memperbarui daftar fitur panjang menjadi sulit atau saat Anda ingin memodifikasi fitur tertentu tanpa menimpa seluruh daftar di dalam image yang sudah dibangun.

Daftar fitur yang dinonaktifkan

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

Sebagai contoh untuk menonaktifkan impersonation, masukkan perintah ini:

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

Tidak diizinkan untuk memiliki fitur dalam daftar features-disabled dan daftar features secara bersamaan.

Fitur yang didukung

Daftar berikut berisi fitur yang didukung yang diaktifkan secara default, dan dapat dinonaktifkan jika tidak diperlukan.

FiturDeskripsi
account-api:v1Account Management REST API
account:v3Account Console versi 3
admin-api:v1Admin API
admin-fine-grained-authz:v2Izin Admin yang Halus versi 2
admin:v2Admin Console baru
authorization:v1Layanan Otorisasi
ciba:v1Otentikasi Backchannel Klien Inisiatif OpenID Connect (CIBA)
client-auth-federated:v1Mengotentikasi klien berdasarkan aseran yang dikeluarkan oleh penyedia identitas
client-policies:v1Kebijakan konfigurasi klien
device-flow:v1Penyetujuan Otorisasi Perangkat OAuth 2.0
dpop:v1Menunjukkan Bukti-Kepemilikan di Lapisan Aplikasi OAuth 2.0
hostname:v2Opsi Nama Host V2
identity-brokering-api:v1Identitas Brokering API V1
impersonation:v1Kemampuan untuk admin meniru pengguna
jwt-authorization-grant:v1Profil JWT untuk Otorisasi OAuth 2.0
kerberos:v1Kerberos
kubernetes-service-accounts:v1Penyedia hubungan kepercayaan akun layanan Kubernetes
log-mdc:v1Informasi Konteks Diagnosa yang Dipetakan (MDC) dalam log
login:v2Tema Masuk Baru
opentelemetry:v1Dukungan OpenTelemetry
organization:v1Dukungan organisasi dalam realm
par:v1Permintaan Otorisasi Diturunkan OAuth 2.0 (PAR)
passkeys:v1Passkeys
persistent-user-sessions:v1Sesi pengguna online yang terus-menerus di restart dan upgrade
recovery-codes:v1Kode pemulihan
rolling-updates:v2Pembaruan bergulir untuk rilis patch
step-up-authentication:v1Otentikasi Naik Tingkat
token-exchange-standard:v2Token Exchange Standar versi 2
update-email:v1Tindakan Pembaruan Email
user-event-metrics:v1Mengumpulkan metrik berdasarkan peristiwa pengguna
web-authn:v1Otentikasi Web W3C (WebAuthn)
workflows:v1Alur kerja

Dinonaktifkan secara default

Daftar berikut berisi fitur yang didukung yang dinonaktifkan secara default, dan dapat diaktifkan jika diperlukan.

FiturDeskripsi
docker:v1Protokol Registri Docker
fips:v1Mode FIPS 140-2
multi-site:v1Dukungan multisite

Fitur Pratinjau

Fitur-fitur pratinjau dinonaktifkan secara default dan tidak disarankan untuk digunakan dalam produksi. Fitur-fitur ini mungkin berubah atau dihapus dalam rilis yang akan datang.

FiturDeskripsi
client-secret-rotation:v1Rotasi Rahasia Klien
http-optimized-serializers:v1Serializer JSON yang dioptimalkan untuk kinerja HTTP yang lebih baik
identity-brokering-api:v2API Penengkarangan Identitas V2
opentelemetry-logs:v1Dukungan Log OpenTelemetry
scripts:v1Menulis autentikator khusus menggunakan JavaScript
spiffe:v1Penyedia hubungan kepercayaan SPIFFE
step-up-authentication-saml:v1Otentikasi Tingkat Lanjut SAML
token-exchange:v1Layanan Pertukaran Token

Fitur Usang

Daftar berikut berisi fitur yang usang yang akan dihapus dalam rilis yang akan datang. Fitur-fitur ini dinonaktifkan secara default.

FiturDeskripsi
admin-fine-grained-authz:v1Izin Admin Halus
instagram-broker:v1Penengkarangan Identitas Instagram
login:v1Tema Login Lama
logout-all-sessions:v1Keluar dari semua sesi hanya keluar dari sesi reguler
passkeys-conditional-ui-authenticator:v1Autentikator UI kondisional Passkeys
rolling-updates:v1Pembaruan Berulang

Opsi Terkait

OpsiTipe atau NilaiDefault
feature-<name>
Aktifkan/Matikan fitur spesifik <feature>.
Mengalahkan opsi features, dan features-disabled. Nilai yang mungkin adalah: enabled, disabled, atau versi spesifik (huruf kecil) yang akan diaktifkan (mis. v2)
CLI: --feature-<name>
Env: KC_FEATURE_<NAME>
String
features
Aktifkan satu atau lebih set fitur.
CLI: --features
Env: KC_FEATURES
account-api[:v1], account[:v3], admin-api[:v1], admin-fine-grained-authz[:v1,v2], admin[:v2], authorization[:v1], ciba[:v1], cimd[:v1], client-admin-api[:v2], client-auth-federated[:v1], client-policies[:v1], client-secret-rotation[:v1], client-types[:v1], clusterless[:v1], db-tidb[:v1], declarative-ui[:v1], device-flow[:v1], docker[:v1], dpop[:v1], dynamic-scopes[:v1], fips[:v1], hostname[:v2], http-optimized-serializers[:v1], identity-brokering-api[:v1,v2], impersonation[:v1], instagram-broker[:v1], ipa-tuura-federation[:v1], jwt-authorization-grant[:v1], kerberos[:v1], kubernetes-service-accounts[:v1], log-mdc[:v1], login[:v2,v1], logout-all-sessions[:v1], multi-site[:v1], oid4vc-vci-preauth-code[:v1], oid4vc-vci[:v1], openapi[:v1], opentelemetry-logs[:v1], opentelemetry-metrics[:v1], opentelemetry[:v1], organization[:v1], par[:v1], passkeys-conditional-ui-authenticator[:v1], passkeys[:v1], persistent-user-sessions[:v1], preview, quick-theme[:v1], recovery-codes[:v1], resource-indicators[:v1], rolling-updates[:v1,v2], scim-api[:v1], scripts[:v1], spiffe[:v1], step-up-authentication-saml[:v1], step-up-authentication[:v1], token-exchange-external-internal[:v2], token-exchange-standard[:v2], token-exchange[:v1], transient-users[:v1], update-email[:v1], user-event-metrics[:v1], web-authn[:v1], workflows[:v1]
features-disabled
Matikan satu atau lebih set fitur.
CLI: --features-disabled
Env: KC_FEATURES_DISABLED
account, account-api, admin, admin-api, admin-fine-grained-authz, authorization, ciba, cimd, client-admin-api, client-auth-federated, client-policies, client-secret-rotation, client-types, clusterless, db-tidb, declarative-ui, device-flow, docker, dpop, dynamic-scopes, fips, http-optimized-serializers, identity-brokering-api, impersonation, instagram-broker, ipa-tuura-federation, jwt-authorization-grant, kerberos, kubernetes-service-accounts, log-mdc, login, logout-all-sessions, multi-site, oid4vc-vci, oid4vc-vci-preauth-code, openapi, opentelemetry, opentelemetry-logs, opentelemetry-metrics, organization, par, passkeys, passkeys-conditional-ui-authenticator, persistent-user-sessions, preview, quick-theme, recovery-codes, resource-indicators, scim-api, scripts, spiffe, step-up-authentication, step-up-authentication-saml, token-exchange, token-exchange-external-internal, token-exchange-standard, transient-users, update-email, user-event-metrics, web-authn, workflows