en
Guides
Server
All provider configuration
enGuidesServerAll Provider Config

All provider configuration

authentication-sessions

infinispan

OptionType or ValuesDefault
spi-authentication-sessions--infinispan--auth-sessions-limit
The maximum number of concurrent authentication sessions per RootAuthenticationSession.
CLI: --spi-authentication-sessions--infinispan--auth-sessions-limit
Env: KC_SPI_AUTHENTICATION_SESSIONS__INFINISPAN__AUTH_SESSIONS_LIMIT
int300

remote

OptionType or ValuesDefault
spi-authentication-sessions--remote--auth-sessions-limit
The maximum number of concurrent authentication sessions per RootAuthenticationSession.
CLI: --spi-authentication-sessions--remote--auth-sessions-limit
Env: KC_SPI_AUTHENTICATION_SESSIONS__REMOTE__AUTH_SESSIONS_LIMIT
int300
spi-authentication-sessions--remote--max-retries
The maximum number of retries if an error occurs.
A value of zero or less disable any retries.
CLI: --spi-authentication-sessions--remote--max-retries
Env: KC_SPI_AUTHENTICATION_SESSIONS__REMOTE__MAX_RETRIES
int10
spi-authentication-sessions--remote--retry-base-time
The base back-off time in milliseconds.
CLI: --spi-authentication-sessions--remote--retry-base-time
Env: KC_SPI_AUTHENTICATION_SESSIONS__REMOTE__RETRY_BASE_TIME
int10

brute-force-protector

default-brute-force-detector

OptionType or ValuesDefault
spi-brute-force-protector--default-brute-force-detector--allow-concurrent-requests
If concurrent logins are allowed by the brute force protection.
CLI: --spi-brute-force-protector--default-brute-force-detector--allow-concurrent-requests
Env: KC_SPI_BRUTE_FORCE_PROTECTOR__DEFAULT_BRUTE_FORCE_DETECTOR__ALLOW_CONCURRENT_REQUESTS
true, falsefalse

cache-embedded

default

OptionType or ValuesDefault
spi-cache-embedded--default--action-tokens-owners
Sets the number of owners for the actionTokens distributed cache.
It defines the number of copies of your data in the cluster.
CLI: --spi-cache-embedded--default--action-tokens-owners
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__ACTION_TOKENS_OWNERS
Integer
spi-cache-embedded--default--authentication-sessions-owners
Sets the number of owners for the authenticationSessions distributed cache.
It defines the number of copies of your data in the cluster.
CLI: --spi-cache-embedded--default--authentication-sessions-owners
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__AUTHENTICATION_SESSIONS_OWNERS
Integer
spi-cache-embedded--default--authorization-max-count
The maximum number of entries that can be stored in-memory by the authorization cache.
CLI: --spi-cache-embedded--default--authorization-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__AUTHORIZATION_MAX_COUNT
Integer
spi-cache-embedded--default--client-sessions-max-count
The maximum number of entries that can be stored in-memory by the clientSessions cache.
CLI: --spi-cache-embedded--default--client-sessions-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__CLIENT_SESSIONS_MAX_COUNT
Integer
spi-cache-embedded--default--client-sessions-owners
Sets the number of owners for the clientSessions distributed cache.
It defines the number of copies of your data in the cluster.
CLI: --spi-cache-embedded--default--client-sessions-owners
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__CLIENT_SESSIONS_OWNERS
Integer
spi-cache-embedded--default--config-file
Defines the file from which cache configuration should be loaded from.
The configuration file is relative to the conf/ directory.
CLI: --spi-cache-embedded--default--config-file
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__CONFIG_FILE
String
spi-cache-embedded--default--crl-max-count
The maximum number of entries that can be stored in-memory by the crl cache.
CLI: --spi-cache-embedded--default--crl-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__CRL_MAX_COUNT
Integer
spi-cache-embedded--default--keys-max-count
The maximum number of entries that can be stored in-memory by the keys cache.
CLI: --spi-cache-embedded--default--keys-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__KEYS_MAX_COUNT
Integer
spi-cache-embedded--default--login-failures-owners
Sets the number of owners for the loginFailures distributed cache.
It defines the number of copies of your data in the cluster.
CLI: --spi-cache-embedded--default--login-failures-owners
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__LOGIN_FAILURES_OWNERS
Integer
spi-cache-embedded--default--machine-name
The name of the physical machine where this instance runs.
It can be set if multiple NQRust-Identity instances are running in the same physical machines. Infinispan takes into consideration this value to keep the backup data spread between different machines.
CLI: --spi-cache-embedded--default--machine-name
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__MACHINE_NAME
String
spi-cache-embedded--default--metrics-histograms-enabled
Enable histograms for metrics for the embedded caches.
CLI: --spi-cache-embedded--default--metrics-histograms-enabled
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__METRICS_HISTOGRAMS_ENABLED
true, falsefalse
spi-cache-embedded--default--network-bind-address
IP address used by clustering transport.
By default, SITE_LOCAL is used.
CLI: --spi-cache-embedded--default--network-bind-address
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__NETWORK_BIND_ADDRESS
String
spi-cache-embedded--default--network-bind-port
The Port the clustering transport will bind to.
By default, port 7800 is used.
CLI: --spi-cache-embedded--default--network-bind-port
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__NETWORK_BIND_PORT
Integer
spi-cache-embedded--default--network-external-address
IP address that other instances in the cluster should use to contact this node.
Set only if it is different to cache-embedded-network-bind-address, for example when this instance is behind a firewall.
CLI: --spi-cache-embedded--default--network-external-address
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__NETWORK_EXTERNAL_ADDRESS
String
spi-cache-embedded--default--network-external-port
Port that other instances in the cluster should use to contact this node.
Set only if it is different to cache-embedded-network-bind-port, for example when this instance is behind a firewall
CLI: --spi-cache-embedded--default--network-external-port
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__NETWORK_EXTERNAL_PORT
Integer
spi-cache-embedded--default--node-name
Sets the name of the current node.
This is a friendly name to make logs, etc. make more sense.
CLI: --spi-cache-embedded--default--node-name
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__NODE_NAME
String
spi-cache-embedded--default--offline-client-sessions-max-count
The maximum number of entries that can be stored in-memory by the offlineClientSessions cache.
CLI: --spi-cache-embedded--default--offline-client-sessions-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__OFFLINE_CLIENT_SESSIONS_MAX_COUNT
Integer
spi-cache-embedded--default--offline-sessions-max-count
The maximum number of entries that can be stored in-memory by the offlineSessions cache.
CLI: --spi-cache-embedded--default--offline-sessions-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__OFFLINE_SESSIONS_MAX_COUNT
Integer
spi-cache-embedded--default--rack-name
The name of the rack where this instance runs.
It can be set if multiple NQRust-Identity instances are running in the same physical rack. Infinispan takes into consideration this value to keep the backup data spread between different racks.
CLI: --spi-cache-embedded--default--rack-name
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__RACK_NAME
String
spi-cache-embedded--default--realms-max-count
The maximum number of entries that can be stored in-memory by the realms cache.
CLI: --spi-cache-embedded--default--realms-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__REALMS_MAX_COUNT
Integer
spi-cache-embedded--default--sessions-max-count
The maximum number of entries that can be stored in-memory by the sessions cache.
CLI: --spi-cache-embedded--default--sessions-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__SESSIONS_MAX_COUNT
Integer
spi-cache-embedded--default--sessions-owners
Sets the number of owners for the sessions distributed cache.
It defines the number of copies of your data in the cluster.
CLI: --spi-cache-embedded--default--sessions-owners
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__SESSIONS_OWNERS
Integer
spi-cache-embedded--default--site-name
The name of the site (availability zone) where this instance runs.
It can be set if running NQRust-Identity in different availability zones. Infinispan takes into consideration this value to keep the backup data spread between different sites.
CLI: --spi-cache-embedded--default--site-name
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__SITE_NAME
String
spi-cache-embedded--default--users-max-count
The maximum number of entries that can be stored in-memory by the users cache.
CLI: --spi-cache-embedded--default--users-max-count
Env: KC_SPI_CACHE_EMBEDDED__DEFAULT__USERS_MAX_COUNT
Integer

cache-remote

default

OptionType or ValuesDefault
spi-cache-remote--default--auth-realm
Specifies the Infinispan server realm to be used for authentication.
CLI: --spi-cache-remote--default--auth-realm
Env: KC_SPI_CACHE_REMOTE__DEFAULT__AUTH_REALM
Stringdefault
spi-cache-remote--default--backup-sites
Configures a list of backup sites names to where the external Infinispan cluster backups the NQRust-Identity data.
CLI: --spi-cache-remote--default--backup-sites
Env: KC_SPI_CACHE_REMOTE__DEFAULT__BACKUP_SITES
List
spi-cache-remote--default--client-intelligence
Specifies the level of intelligence the Hot Rod client should have.
CLI: --spi-cache-remote--default--client-intelligence
Env: KC_SPI_CACHE_REMOTE__DEFAULT__CLIENT_INTELLIGENCE
BASIC, TOPOLOGY_AWARE, HASH_DISTRIBUTION_AWAREHASH_DISTRIBUTION_AWARE
spi-cache-remote--default--connection-pool-exhausted-action
Specifies what happens when asking for a connection from a server’s pool, and that pool is exhausted.
CLI: --spi-cache-remote--default--connection-pool-exhausted-action
Env: KC_SPI_CACHE_REMOTE__DEFAULT__CONNECTION_POOL_EXHAUSTED_ACTION
EXCEPTION, WAIT, CREATE_NEWCREATE_NEW
spi-cache-remote--default--connection-pool-max-active
Sets the maximum number of connections per Infinispan server instance.
CLI: --spi-cache-remote--default--connection-pool-max-active
Env: KC_SPI_CACHE_REMOTE__DEFAULT__CONNECTION_POOL_MAX_ACTIVE
Integer16
spi-cache-remote--default--hostname
The hostname of the external Infinispan cluster.
CLI: --spi-cache-remote--default--hostname
Env: KC_SPI_CACHE_REMOTE__DEFAULT__HOSTNAME
String
spi-cache-remote--default--password
The password for the authentication to the external Infinispan cluster.
It is optional if connecting to an unsecure external Infinispan cluster. If the option is specified, cache-remote-username is required as well.
CLI: --spi-cache-remote--default--password
Env: KC_SPI_CACHE_REMOTE__DEFAULT__PASSWORD
String
spi-cache-remote--default--port
The port of the external Infinispan cluster.
CLI: --spi-cache-remote--default--port
Env: KC_SPI_CACHE_REMOTE__DEFAULT__PORT
Integer11222
spi-cache-remote--default--properties-file
Path to the properties file with the Hot Rod client configuration.
CLI: --spi-cache-remote--default--properties-file
Env: KC_SPI_CACHE_REMOTE__DEFAULT__PROPERTIES_FILE
File
spi-cache-remote--default--sasl-mechanism
Selects the SASL mechanism to use for the connection to the Infinispan server.
CLI: --spi-cache-remote--default--sasl-mechanism
Env: KC_SPI_CACHE_REMOTE__DEFAULT__SASL_MECHANISM
StringSCRAM-SHA-512
spi-cache-remote--default--tls-enabled
Enable TLS support to communicate with a secured remote Infinispan server.
Recommended to be enabled in production.
CLI: --spi-cache-remote--default--tls-enabled
Env: KC_SPI_CACHE_REMOTE__DEFAULT__TLS_ENABLED
true, falsetrue
spi-cache-remote--default--tls-sni-hostname
Specifies the TLS SNI hostname for the connection to the Infinispan server.
CLI: --spi-cache-remote--default--tls-sni-hostname
Env: KC_SPI_CACHE_REMOTE__DEFAULT__TLS_SNI_HOSTNAME
String
spi-cache-remote--default--username
The username for the authentication to the external Infinispan cluster.
It is optional if connecting to an unsecure external Infinispan cluster. If the option is specified, cache-remote-password is required as well.
CLI: --spi-cache-remote--default--username
Env: KC_SPI_CACHE_REMOTE__DEFAULT__USERNAME
String

ciba-auth-channel

ciba-http-auth-channel

OptionType or ValuesDefault
spi-ciba-auth-channel--ciba-http-auth-channel--http-authentication-channel-uri
The HTTP(S) URI of the authentication channel.
CLI: --spi-ciba-auth-channel--ciba-http-auth-channel--http-authentication-channel-uri
Env: KC_SPI_CIBA_AUTH_CHANNEL__CIBA_HTTP_AUTH_CHANNEL__HTTP_AUTHENTICATION_CHANNEL_URI
string

client-policy-executor

client-id-metadata-document

OptionType or ValuesDefault
spi-client-policy-executor--client-id-metadata-document--cimd-provider-name
Provider to use for the CIMD
CLI: --spi-client-policy-executor--client-id-metadata-document--cimd-provider-name
Env: KC_SPI_CLIENT_POLICY_EXECUTOR__CLIENT_ID_METADATA_DOCUMENT__CIMD_PROVIDER_NAME
stringpersistent-cimd
spi-client-policy-executor--client-id-metadata-document--max-cache-time
Max cache time of client metadata in seconds for the CIMD.
CLI: --spi-client-policy-executor--client-id-metadata-document--max-cache-time
Env: KC_SPI_CLIENT_POLICY_EXECUTOR__CLIENT_ID_METADATA_DOCUMENT__MAX_CACHE_TIME
int259200
spi-client-policy-executor--client-id-metadata-document--min-cache-time
Min cache time of client metadata in seconds for the CIMD.
CLI: --spi-client-policy-executor--client-id-metadata-document--min-cache-time
Env: KC_SPI_CLIENT_POLICY_EXECUTOR__CLIENT_ID_METADATA_DOCUMENT__MIN_CACHE_TIME
int300
spi-client-policy-executor--client-id-metadata-document--upper-limit-metadata-bytes
Client metadata upper limit in byte for the CIMD.
CLI: --spi-client-policy-executor--client-id-metadata-document--upper-limit-metadata-bytes
Env: KC_SPI_CLIENT_POLICY_EXECUTOR__CLIENT_ID_METADATA_DOCUMENT__UPPER_LIMIT_METADATA_BYTES
int5000

connections-http-client

default

OptionType or ValuesDefault
spi-connections-http-client--default--backoff-multiplier
Multiplier for exponential backoff between retry attempts.
For example, with an initial backoff of 1000ms and a multiplier of 2.0, the retry delays would be: 1000ms, 2000ms, 4000ms, etc.
CLI: --spi-connections-http-client--default--backoff-multiplier
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__BACKOFF_MULTIPLIER
string2.0
spi-connections-http-client--default--client-key-password
The key password.
CLI: --spi-connections-http-client--default--client-key-password
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CLIENT_KEY_PASSWORD
string-1
spi-connections-http-client--default--client-keystore
The file path of the key store from where the key material is going to be read from to set-up TLS connections.
CLI: --spi-connections-http-client--default--client-keystore
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CLIENT_KEYSTORE
string
spi-connections-http-client--default--client-keystore-password
The key store password.
CLI: --spi-connections-http-client--default--client-keystore-password
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CLIENT_KEYSTORE_PASSWORD
string
spi-connections-http-client--default--connection-pool-size
Assigns maximum total connection value.
CLI: --spi-connections-http-client--default--connection-pool-size
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CONNECTION_POOL_SIZE
int
spi-connections-http-client--default--connection-request-timeout-millis
Timeout when trying to obtain any connection, new or pooled.
CLI: --spi-connections-http-client--default--connection-request-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CONNECTION_REQUEST_TIMEOUT_MILLIS
long5000
spi-connections-http-client--default--connection-ttl-millis
Sets maximum time, in milliseconds, to live for persistent connections.
CLI: --spi-connections-http-client--default--connection-ttl-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__CONNECTION_TTL_MILLIS
long-1
spi-connections-http-client--default--disable-cookies
Disables state (cookie) management.
CLI: --spi-connections-http-client--default--disable-cookies
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__DISABLE_COOKIES
true, falsetrue
spi-connections-http-client--default--disable-trust-manager
Disable trust management and hostname verification.
NOTE this is a security hole, so only set this option if you cannot or do not want to verify the identity of the host you are communicating with.
CLI: --spi-connections-http-client--default--disable-trust-manager
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__DISABLE_TRUST_MANAGER
true, falsefalse
spi-connections-http-client--default--establish-connection-timeout-millis
Timeout when making an initial socket connection.
Only effective if less than the connection-request-timeout-millis.
CLI: --spi-connections-http-client--default--establish-connection-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__ESTABLISH_CONNECTION_TIMEOUT_MILLIS
long-1
spi-connections-http-client--default--initial-backoff-millis
Initial backoff time in milliseconds before the first retry attempt.
CLI: --spi-connections-http-client--default--initial-backoff-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__INITIAL_BACKOFF_MILLIS
long1000
spi-connections-http-client--default--jitter-factor
Jitter factor to apply to backoff times.
A value of 0.5 means the actual backoff time will be between 50% and 150% of the calculated exponential backoff time.
CLI: --spi-connections-http-client--default--jitter-factor
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__JITTER_FACTOR
string0.5
spi-connections-http-client--default--max-connection-idle-time-millis
Sets the time, in milliseconds, for evicting idle connections from the pool.
CLI: --spi-connections-http-client--default--max-connection-idle-time-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__MAX_CONNECTION_IDLE_TIME_MILLIS
long900000
spi-connections-http-client--default--max-consumed-response-size
Maximum size of a response consumed by the client (to prevent denial of service)
CLI: --spi-connections-http-client--default--max-consumed-response-size
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__MAX_CONSUMED_RESPONSE_SIZE
long10000000
spi-connections-http-client--default--max-pooled-per-route
Assigns maximum connection per route value.
CLI: --spi-connections-http-client--default--max-pooled-per-route
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__MAX_POOLED_PER_ROUTE
int64
spi-connections-http-client--default--max-retries
Maximum number of retry attempts for all outgoing HTTP requests.
Set to 0 to disable retries (default).
CLI: --spi-connections-http-client--default--max-retries
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__MAX_RETRIES
int0
spi-connections-http-client--default--proxy-mappings
Denotes the combination of a regex based hostname pattern and a proxy-uri in the form of hostnamePattern;proxyUri.
CLI: --spi-connections-http-client--default--proxy-mappings
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__PROXY_MAPPINGS
string
spi-connections-http-client--default--reuse-connections
If connections should be reused.
CLI: --spi-connections-http-client--default--reuse-connections
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__REUSE_CONNECTIONS
true, falsetrue
spi-connections-http-client--default--socket-timeout-millis
Socket inactivity timeout.
CLI: --spi-connections-http-client--default--socket-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__SOCKET_TIMEOUT_MILLIS
long5000
spi-connections-http-client--default--use-jitter
Whether to apply jitter to backoff times to prevent synchronized retry storms when multiple clients are retrying at the same time.
CLI: --spi-connections-http-client--default--use-jitter
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__DEFAULT__USE_JITTER
true, falsetrue

opentelemetry

OptionType or ValuesDefault
spi-connections-http-client--opentelemetry--backoff-multiplier
Multiplier for exponential backoff between retry attempts.
For example, with an initial backoff of 1000ms and a multiplier of 2.0, the retry delays would be: 1000ms, 2000ms, 4000ms, etc.
CLI: --spi-connections-http-client--opentelemetry--backoff-multiplier
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__BACKOFF_MULTIPLIER
string2.0
spi-connections-http-client--opentelemetry--client-key-password
The key password.
CLI: --spi-connections-http-client--opentelemetry--client-key-password
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CLIENT_KEY_PASSWORD
string-1
spi-connections-http-client--opentelemetry--client-keystore
The file path of the key store from where the key material is going to be read from to set-up TLS connections.
CLI: --spi-connections-http-client--opentelemetry--client-keystore
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CLIENT_KEYSTORE
string
spi-connections-http-client--opentelemetry--client-keystore-password
The key store password.
CLI: --spi-connections-http-client--opentelemetry--client-keystore-password
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CLIENT_KEYSTORE_PASSWORD
string
spi-connections-http-client--opentelemetry--connection-pool-size
Assigns maximum total connection value.
CLI: --spi-connections-http-client--opentelemetry--connection-pool-size
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CONNECTION_POOL_SIZE
int
spi-connections-http-client--opentelemetry--connection-request-timeout-millis
Timeout when trying to obtain any connection, new or pooled.
CLI: --spi-connections-http-client--opentelemetry--connection-request-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CONNECTION_REQUEST_TIMEOUT_MILLIS
long5000
spi-connections-http-client--opentelemetry--connection-ttl-millis
Sets maximum time, in milliseconds, to live for persistent connections.
CLI: --spi-connections-http-client--opentelemetry--connection-ttl-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__CONNECTION_TTL_MILLIS
long-1
spi-connections-http-client--opentelemetry--disable-cookies
Disables state (cookie) management.
CLI: --spi-connections-http-client--opentelemetry--disable-cookies
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__DISABLE_COOKIES
true, falsetrue
spi-connections-http-client--opentelemetry--disable-trust-manager
Disable trust management and hostname verification.
NOTE this is a security hole, so only set this option if you cannot or do not want to verify the identity of the host you are communicating with.
CLI: --spi-connections-http-client--opentelemetry--disable-trust-manager
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__DISABLE_TRUST_MANAGER
true, falsefalse
spi-connections-http-client--opentelemetry--establish-connection-timeout-millis
Timeout when making an initial socket connection.
Only effective if less than the connection-request-timeout-millis.
CLI: --spi-connections-http-client--opentelemetry--establish-connection-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__ESTABLISH_CONNECTION_TIMEOUT_MILLIS
long-1
spi-connections-http-client--opentelemetry--initial-backoff-millis
Initial backoff time in milliseconds before the first retry attempt.
CLI: --spi-connections-http-client--opentelemetry--initial-backoff-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__INITIAL_BACKOFF_MILLIS
long1000
spi-connections-http-client--opentelemetry--jitter-factor
Jitter factor to apply to backoff times.
A value of 0.5 means the actual backoff time will be between 50% and 150% of the calculated exponential backoff time.
CLI: --spi-connections-http-client--opentelemetry--jitter-factor
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__JITTER_FACTOR
string0.5
spi-connections-http-client--opentelemetry--max-connection-idle-time-millis
Sets the time, in milliseconds, for evicting idle connections from the pool.
CLI: --spi-connections-http-client--opentelemetry--max-connection-idle-time-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__MAX_CONNECTION_IDLE_TIME_MILLIS
long900000
spi-connections-http-client--opentelemetry--max-consumed-response-size
Maximum size of a response consumed by the client (to prevent denial of service)
CLI: --spi-connections-http-client--opentelemetry--max-consumed-response-size
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__MAX_CONSUMED_RESPONSE_SIZE
long10000000
spi-connections-http-client--opentelemetry--max-pooled-per-route
Assigns maximum connection per route value.
CLI: --spi-connections-http-client--opentelemetry--max-pooled-per-route
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__MAX_POOLED_PER_ROUTE
int64
spi-connections-http-client--opentelemetry--max-retries
Maximum number of retry attempts for all outgoing HTTP requests.
Set to 0 to disable retries (default).
CLI: --spi-connections-http-client--opentelemetry--max-retries
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__MAX_RETRIES
int0
spi-connections-http-client--opentelemetry--proxy-mappings
Denotes the combination of a regex based hostname pattern and a proxy-uri in the form of hostnamePattern;proxyUri.
CLI: --spi-connections-http-client--opentelemetry--proxy-mappings
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__PROXY_MAPPINGS
string
spi-connections-http-client--opentelemetry--reuse-connections
If connections should be reused.
CLI: --spi-connections-http-client--opentelemetry--reuse-connections
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__REUSE_CONNECTIONS
true, falsetrue
spi-connections-http-client--opentelemetry--socket-timeout-millis
Socket inactivity timeout.
CLI: --spi-connections-http-client--opentelemetry--socket-timeout-millis
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__SOCKET_TIMEOUT_MILLIS
long5000
spi-connections-http-client--opentelemetry--use-jitter
Whether to apply jitter to backoff times to prevent synchronized retry storms when multiple clients are retrying at the same time.
CLI: --spi-connections-http-client--opentelemetry--use-jitter
Env: KC_SPI_CONNECTIONS_HTTP_CLIENT__OPENTELEMETRY__USE_JITTER
true, falsetrue

connections-jpa

quarkus

OptionType or ValuesDefault
spi-connections-jpa--quarkus--initialize-empty
Initialize database if empty.
If set to false the database has to be manually initialized. If you want to manually initialize the database set migrationStrategy to manual which will create a file with SQL commands to initialize the database.
CLI: --spi-connections-jpa--quarkus--initialize-empty
Env: KC_SPI_CONNECTIONS_JPA__QUARKUS__INITIALIZE_EMPTY
true, falsetrue
spi-connections-jpa--quarkus--migration-export
Path for where to write manual database initialization/migration file.
CLI: --spi-connections-jpa--quarkus--migration-export
Env: KC_SPI_CONNECTIONS_JPA__QUARKUS__MIGRATION_EXPORT
string
spi-connections-jpa--quarkus--migration-strategy
Strategy to use to migrate database.
Valid values are update, manual and validate. Update will automatically migrate the database schema. Manual will export the required changes to a file with SQL commands that you can manually execute on the database. Validate will simply check if the database is up-to-date.
CLI: --spi-connections-jpa--quarkus--migration-strategy
Env: KC_SPI_CONNECTIONS_JPA__QUARKUS__MIGRATION_STRATEGY
update, manual, validateupdate

cors

default

OptionType or ValuesDefault
spi-cors--default--allowed-headers
A comma-separated list of additional allowed headers for CORS requests
CLI: --spi-cors--default--allowed-headers
Env: KC_SPI_CORS__DEFAULT__ALLOWED_HEADERS
string

credential

nqrust-identity-password

OptionType or ValuesDefault
spi-credential--keycloak-password--validations-counter-tags
Comma-separated list of tags to be used when publishing password validation counter metric.
CLI: --spi-credential--keycloak-password--validations-counter-tags
Env: KC_SPI_CREDENTIAL__KEYCLOAK_PASSWORD__VALIDATIONS_COUNTER_TAGS
realm, algorithm, hashing_strength, outcomerealm,algorithm,hashing_strength,outcome

crl-storage

infinispan

OptionType or ValuesDefault
spi-crl-storage--infinispan--cache-time
Interval in seconds that the CRL is cached.
The next update time of the CRL is always a minimum if present.
Zero or a negative value means CRL is cached until the next update time specified in the CRL (or infinite if the
CRL does not contain the next update).
CLI: --spi-crl-storage--infinispan--cache-time
Env: KC_SPI_CRL_STORAGE__INFINISPAN__CACHE_TIME
int-1
spi-crl-storage--infinispan--min-time-between-requests
Minimum interval in seconds between two requests to retrieve the CRL.
The CRL is not updated
from the URL again until this minimum time has passed since the previous refresh. In theory
this option is never used if the CRL is refreshed correctly in the next update time.
The interval should be a positive number. Default 10 seconds.
CLI: --spi-crl-storage--infinispan--min-time-between-requests
Env: KC_SPI_CRL_STORAGE__INFINISPAN__MIN_TIME_BETWEEN_REQUESTS
int10

datastore

legacy

OptionType or ValuesDefault
spi-datastore--legacy--allow-migrate-existing-database-to-snapshot
By default, it is not allowed to run the snapshot/development server against the database, which was previously migrated to some officially released server version.
As an attempt of doing this indicates that you are trying to run development server against production database, which can result in a loss or corruption of data, and also does not allow upgrading. If it is really intended, you can use this option, which will allow to use nightly/development server against production database when explicitly switch to true. This option is recommended just in the development environments and should be never used in the production!
CLI: --spi-datastore--legacy--allow-migrate-existing-database-to-snapshot
Env: KC_SPI_DATASTORE__LEGACY__ALLOW_MIGRATE_EXISTING_DATABASE_TO_SNAPSHOT
true, falsefalse

device-representation

device-representation

OptionType or ValuesDefault
spi-device-representation--device-representation--cache-size
Sets the maximum number of parsed user-agent values in the local cache.
CLI: --spi-device-representation--device-representation--cache-size
Env: KC_SPI_DEVICE_REPRESENTATION__DEVICE_REPRESENTATION__CACHE_SIZE
Integer2048

events-listener

email

OptionType or ValuesDefault
spi-events-listener--email--exclude-events
A comma-separated list of events that should not be sent via email to the user’s account.
CLI: --spi-events-listener--email--exclude-events
Env: KC_SPI_EVENTS_LISTENER__EMAIL__EXCLUDE_EVENTS
authreqid_to_token, authreqid_to_token_error, client_delete, client_delete_error, client_info, client_info_error, client_initiated_account_linking, client_initiated_account_linking_error, client_login, client_login_error, client_register, client_register_error, client_update, client_update_error, code_to_token, code_to_token_error, custom_required_action, custom_required_action_error, delete_account, delete_account_error, execute_action_token, execute_action_token_error, execute_actions, execute_actions_error, federated_identity_link, federated_identity_link_error, federated_identity_override_link, federated_identity_override_link_error, grant_consent, grant_consent_error, identity_provider_first_login, identity_provider_first_login_error, identity_provider_link_account, identity_provider_link_account_error, identity_provider_login, identity_provider_login_error, identity_provider_post_login, identity_provider_post_login_error, identity_provider_response, identity_provider_response_error, identity_provider_retrieve_token, identity_provider_retrieve_token_error, impersonate, impersonate_error, introspect_token, introspect_token_error, invalid_signature, invalid_signature_error, invite_org, invite_org_error, jwt_authorization_grant, jwt_authorization_grant_error, login, login_error, logout, logout_error, oauth2_device_auth, oauth2_device_auth_error, oauth2_device_code_to_token, oauth2_device_code_to_token_error, oauth2_device_verify_user_code, oauth2_device_verify_user_code_error, oauth2_extension_grant, oauth2_extension_grant_error, permission_token, permission_token_error, pushed_authorization_request, pushed_authorization_request_error, refresh_token, refresh_token_error, register, register_error, register_node, register_node_error, remove_credential, remove_credential_error, remove_federated_identity, remove_federated_identity_error, remove_totp, remove_totp_error, reset_password, reset_password_error, restart_authentication, restart_authentication_error, revoke_grant, revoke_grant_error, send_identity_provider_link, send_identity_provider_link_error, send_reset_password, send_reset_password_error, send_verify_email, send_verify_email_error, token_exchange, token_exchange_error, unregister_node, unregister_node_error, update_consent, update_consent_error, update_credential, update_credential_error, update_email, update_email_error, update_password, update_password_error, update_profile, update_profile_error, update_totp, update_totp_error, user_disabled_by_permanent_lockout, user_disabled_by_permanent_lockout_error, user_disabled_by_temporary_lockout, user_disabled_by_temporary_lockout_error, user_info_request, user_info_request_error, user_session_deleted, user_session_deleted_error, validate_access_token, validate_access_token_error, verifiable_credential_create_offer, verifiable_credential_create_offer_error, verifiable_credential_nonce_request, verifiable_credential_nonce_request_error, verifiable_credential_offer_request, verifiable_credential_offer_request_error, verifiable_credential_pre_authorized_grant, verifiable_credential_pre_authorized_grant_error, verifiable_credential_request, verifiable_credential_request_error, verify_email, verify_email_error, verify_profile, verify_profile_error
spi-events-listener--email--include-events
A comma-separated list of events that should be sent via email to the user’s account.
CLI: --spi-events-listener--email--include-events
Env: KC_SPI_EVENTS_LISTENER__EMAIL__INCLUDE_EVENTS
authreqid_to_token, authreqid_to_token_error, client_delete, client_delete_error, client_info, client_info_error, client_initiated_account_linking, client_initiated_account_linking_error, client_login, client_login_error, client_register, client_register_error, client_update, client_update_error, code_to_token, code_to_token_error, custom_required_action, custom_required_action_error, delete_account, delete_account_error, execute_action_token, execute_action_token_error, execute_actions, execute_actions_error, federated_identity_link, federated_identity_link_error, federated_identity_override_link, federated_identity_override_link_error, grant_consent, grant_consent_error, identity_provider_first_login, identity_provider_first_login_error, identity_provider_link_account, identity_provider_link_account_error, identity_provider_login, identity_provider_login_error, identity_provider_post_login, identity_provider_post_login_error, identity_provider_response, identity_provider_response_error, identity_provider_retrieve_token, identity_provider_retrieve_token_error, impersonate, impersonate_error, introspect_token, introspect_token_error, invalid_signature, invalid_signature_error, invite_org, invite_org_error, jwt_authorization_grant, jwt_authorization_grant_error, login, login_error, logout, logout_error, oauth2_device_auth, oauth2_device_auth_error, oauth2_device_code_to_token, oauth2_device_code_to_token_error, oauth2_device_verify_user_code, oauth2_device_verify_user_code_error, oauth2_extension_grant, oauth2_extension_grant_error, permission_token, permission_token_error, pushed_authorization_request, pushed_authorization_request_error, refresh_token, refresh_token_error, register, register_error, register_node, register_node_error, remove_credential, remove_credential_error, remove_federated_identity, remove_federated_identity_error, remove_totp, remove_totp_error, reset_password, reset_password_error, restart_authentication, restart_authentication_error, revoke_grant, revoke_grant_error, send_identity_provider_link, send_identity_provider_link_error, send_reset_password, send_reset_password_error, send_verify_email, send_verify_email_error, token_exchange, token_exchange_error, unregister_node, unregister_node_error, update_consent, update_consent_error, update_credential, update_credential_error, update_email, update_email_error, update_password, update_password_error, update_profile, update_profile_error, update_totp, update_totp_error, user_disabled_by_permanent_lockout, user_disabled_by_permanent_lockout_error, user_disabled_by_temporary_lockout, user_disabled_by_temporary_lockout_error, user_info_request, user_info_request_error, user_session_deleted, user_session_deleted_error, validate_access_token, validate_access_token_error, verifiable_credential_create_offer, verifiable_credential_create_offer_error, verifiable_credential_nonce_request, verifiable_credential_nonce_request_error, verifiable_credential_offer_request, verifiable_credential_offer_request_error, verifiable_credential_pre_authorized_grant, verifiable_credential_pre_authorized_grant_error, verifiable_credential_request, verifiable_credential_request_error, verify_email, verify_email_error, verify_profile, verify_profile_errorAll events

jboss-logging

OptionType or ValuesDefault
spi-events-listener--jboss-logging--error-level
The log level for error messages.
CLI: --spi-events-listener--jboss-logging--error-level
Env: KC_SPI_EVENTS_LISTENER__JBOSS_LOGGING__ERROR_LEVEL
debug, error, fatal, info, trace, warnwarn
spi-events-listener--jboss-logging--include-representation
When "true" the "representation" field with the JSON admin object is also added to the message.
The realm should be also configured to include representation for the admin events.
CLI: --spi-events-listener--jboss-logging--include-representation
Env: KC_SPI_EVENTS_LISTENER__JBOSS_LOGGING__INCLUDE_REPRESENTATION
true, falsefalse
spi-events-listener--jboss-logging--quotes
The quotes to use for values, it should be one character like " or '.
Use "none" if quotes are not needed.
CLI: --spi-events-listener--jboss-logging--quotes
Env: KC_SPI_EVENTS_LISTENER__JBOSS_LOGGING__QUOTES
string"
spi-events-listener--jboss-logging--sanitize
If true the log messages are sanitized to avoid line breaks.
If false messages are not sanitized.
CLI: --spi-events-listener--jboss-logging--sanitize
Env: KC_SPI_EVENTS_LISTENER__JBOSS_LOGGING__SANITIZE
true, falsetrue
spi-events-listener--jboss-logging--success-level
The log level for success messages.
CLI: --spi-events-listener--jboss-logging--success-level
Env: KC_SPI_EVENTS_LISTENER__JBOSS_LOGGING__SUCCESS_LEVEL
debug, error, fatal, info, trace, warndebug

export

dir

OptionType or ValuesDefault
spi-export--dir--dir
Directory to export to
CLI: --spi-export--dir--dir
Env: KC_SPI_EXPORT__DIR__DIR
string
spi-export--dir--realm-name
Realm to export
CLI: --spi-export--dir--realm-name
Env: KC_SPI_EXPORT__DIR__REALM_NAME
string
spi-export--dir--users-export-strategy
Users export strategy
CLI: --spi-export--dir--users-export-strategy
Env: KC_SPI_EXPORT__DIR__USERS_EXPORT_STRATEGY
stringDIFFERENT_FILES
spi-export--dir--users-per-file
Users per exported file
CLI: --spi-export--dir--users-per-file
Env: KC_SPI_EXPORT__DIR__USERS_PER_FILE
int50

single-file

OptionType or ValuesDefault
spi-export--single-file--file
File to export to
CLI: --spi-export--single-file--file
Env: KC_SPI_EXPORT__SINGLE_FILE__FILE
string
spi-export--single-file--realm-name
Realm to export
CLI: --spi-export--single-file--realm-name
Env: KC_SPI_EXPORT__SINGLE_FILE__REALM_NAME
string

group

jpa

OptionType or ValuesDefault
spi-group--jpa--escape-slashes-in-group-path
If true slashes / in group names are escaped with the character ~ when converted to paths.
CLI: --spi-group--jpa--escape-slashes-in-group-path
Env: KC_SPI_GROUP__JPA__ESCAPE_SLASHES_IN_GROUP_PATH
true, falsefalse
spi-group--jpa--searchable-attributes
The list of attributes separated by comma that are allowed in client attribute searches.
CLI: --spi-group--jpa--searchable-attributes
Env: KC_SPI_GROUP__JPA__SEARCHABLE_ATTRIBUTES
string

import

dir

OptionType or ValuesDefault
spi-import--dir--dir
Directory to import from
CLI: --spi-import--dir--dir
Env: KC_SPI_IMPORT__DIR__DIR
string
spi-import--dir--realm-name
Realm to export
CLI: --spi-import--dir--realm-name
Env: KC_SPI_IMPORT__DIR__REALM_NAME
string
spi-import--dir--strategy
Strategy for import: IGNORE_EXISTING, OVERWRITE_EXISTING
CLI: --spi-import--dir--strategy
Env: KC_SPI_IMPORT__DIR__STRATEGY
string

single-file

OptionType or ValuesDefault
spi-import--single-file--file
File to import from
CLI: --spi-import--single-file--file
Env: KC_SPI_IMPORT__SINGLE_FILE__FILE
string
spi-import--single-file--realm-name
Realm to export
CLI: --spi-import--single-file--realm-name
Env: KC_SPI_IMPORT__SINGLE_FILE__REALM_NAME
string
spi-import--single-file--strategy
Strategy for import: IGNORE_EXISTING, OVERWRITE_EXISTING
CLI: --spi-import--single-file--strategy
Env: KC_SPI_IMPORT__SINGLE_FILE__STRATEGY
string

jgroups-mtls

default

OptionType or ValuesDefault
spi-jgroups-mtls--default--enabled
Encrypts the network communication between NQRust-Identity servers.
If no additional parameters about a keystore and truststore are provided, ephemeral key pairs and certificates are created and rotated automatically, which is recommended for standard setups.
CLI: --spi-jgroups-mtls--default--enabled
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__ENABLED
true, falsetrue
spi-jgroups-mtls--default--keystore-file
The Keystore file path.
The Keystore must contain the certificate to use by the TLS protocol. By default, it looks up cache-mtls-keystore.p12 under conf/ directory.
CLI: --spi-jgroups-mtls--default--keystore-file
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__KEYSTORE_FILE
String
spi-jgroups-mtls--default--keystore-password
The password to access the Keystore.
CLI: --spi-jgroups-mtls--default--keystore-password
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__KEYSTORE_PASSWORD
Password
spi-jgroups-mtls--default--rotation
Rotation period in days of automatic JGroups MTLS certificates.
CLI: --spi-jgroups-mtls--default--rotation
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__ROTATION
Integer30
spi-jgroups-mtls--default--truststore-file
The Truststore file path.
It should contain the trusted certificates or the Certificate Authority that signed the certificates. By default, it lookup cache-mtls-truststore.p12 under conf/ directory.
CLI: --spi-jgroups-mtls--default--truststore-file
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__TRUSTSTORE_FILE
String
spi-jgroups-mtls--default--truststore-password
The password to access the Truststore.
CLI: --spi-jgroups-mtls--default--truststore-password
Env: KC_SPI_JGROUPS_MTLS__DEFAULT__TRUSTSTORE_PASSWORD
Password

load-balancer-check

remote

OptionType or ValuesDefault
spi-load-balancer-check--remote--poll-interval
The Remote caches poll interval, in milliseconds, for connection availability
CLI: --spi-load-balancer-check--remote--poll-interval
Env: KC_SPI_LOAD_BALANCER_CHECK__REMOTE__POLL_INTERVAL
int5000

login-protocol

openid-connect

OptionType or ValuesDefault
spi-login-protocol--openid-connect--add-req-params-fail-fast
Whether the fail-fast strategy should be enforced in case if the limit for some standard OIDC parameter or additional OIDC parameter is not met for the parameters sent to the OIDC authentication or token endpoints.
If false, then all additional request parameters to not meet the configuration are silently ignored. If true, an exception will be raised and request to the OIDC authentication or token endpoints will not be allowed.
CLI: --spi-login-protocol--openid-connect--add-req-params-fail-fast
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__ADD_REQ_PARAMS_FAIL_FAST
true, falsefalse
spi-login-protocol--openid-connect--add-req-params-max-number
Maximum number of additional request parameters sent to the OIDC authentication or token endpoints.
As 'additional request parameter' is meant some custom parameter not directly treated as standard OIDC/OAuth2 protocol parameter. Additional parameters might be useful for example to add custom claims to the OIDC token (in case that also particular protocol mappers are configured).
CLI: --spi-login-protocol--openid-connect--add-req-params-max-number
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__ADD_REQ_PARAMS_MAX_NUMBER
int5
spi-login-protocol--openid-connect--add-req-params-max-overall-size
Maximum size of all additional request parameters values together.
See add-req-params-max-number for more details about additional request parameters
CLI: --spi-login-protocol--openid-connect--add-req-params-max-overall-size
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__ADD_REQ_PARAMS_MAX_OVERALL_SIZE
int2147483647
spi-login-protocol--openid-connect--add-req-params-max-size
Maximum size of single additional request parameter value See add-req-params-max-number for more details about additional request parameters
CLI: --spi-login-protocol--openid-connect--add-req-params-max-size
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__ADD_REQ_PARAMS_MAX_SIZE
int2000
spi-login-protocol--openid-connect--req-params-default-max-size
Maximum default length of the standard OIDC parameter sent to the OIDC authentication or token endpoints.
This applies to most of the standard parameters like for example state, nonce etc. The exception is login_hint parameter, which has maximum length of 255 characters.
CLI: --spi-login-protocol--openid-connect--req-params-default-max-size
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__REQ_PARAMS_DEFAULT_MAX_SIZE
int4000
spi-login-protocol--openid-connect--req-params-max-size--login_hint
Maximum length of the standard parameter sent to OIDC authentication or token endpoints overriden for the specified parameter.
Useful if some standard OIDC parameter should have different limit than req-params-default-max-size. It is needed to add the name of the parameter after this prefix into the configuration. In this example, the login_hint parameter is used, but this format is supported for any known standard OIDC/OAuth2 parameter.
CLI: --spi-login-protocol--openid-connect--req-params-max-size--login_hint
Env: KC_SPI_LOGIN_PROTOCOL__OPENID_CONNECT__REQ_PARAMS_MAX_SIZE__LOGIN_HINT
int

saml

OptionType or ValuesDefault
spi-login-protocol--saml--max-inflating-size
The maximum inflating size in bytes for the REDIRECT binding.
CLI: --spi-login-protocol--saml--max-inflating-size
Env: KC_SPI_LOGIN_PROTOCOL__SAML__MAX_INFLATING_SIZE
long131072

login-failure

remote

OptionType or ValuesDefault
spi-login-failure--remote--max-retries
The maximum number of retries if an error occurs.
A value of zero or less disable any retries.
CLI: --spi-login-failure--remote--max-retries
Env: KC_SPI_LOGIN_FAILURE__REMOTE__MAX_RETRIES
int10
spi-login-failure--remote--retry-base-time
The base back-off time in milliseconds.
CLI: --spi-login-failure--remote--retry-base-time
Env: KC_SPI_LOGIN_FAILURE__REMOTE__RETRY_BASE_TIME
int10

mapped-diagnostic-context

default

OptionType or ValuesDefault
spi-mapped-diagnostic-context--default--mdc-keys
Comma-separated list of MDC keys to add to the Mapped Diagnostic Context.
CLI: --spi-mapped-diagnostic-context--default--mdc-keys
Env: KC_SPI_MAPPED_DIAGNOSTIC_CONTEXT__DEFAULT__MDC_KEYS
realmName, clientId, userId, ipAddress, org, sessionId, authenticationSessionId, authenticationTabId

password-hashing

argon2

OptionType or ValuesDefault
spi-password-hashing--argon2--cpu-cores
Maximum parallel CPU cores to use for hashing
CLI: --spi-password-hashing--argon2--cpu-cores
Env: KC_SPI_PASSWORD_HASHING__ARGON2__CPU_CORES
int
spi-password-hashing--argon2--hash-length
Hash length
CLI: --spi-password-hashing--argon2--hash-length
Env: KC_SPI_PASSWORD_HASHING__ARGON2__HASH_LENGTH
int32
spi-password-hashing--argon2--iterations
Iterations
CLI: --spi-password-hashing--argon2--iterations
Env: KC_SPI_PASSWORD_HASHING__ARGON2__ITERATIONS
int5
spi-password-hashing--argon2--memory
Memory size (KB)
CLI: --spi-password-hashing--argon2--memory
Env: KC_SPI_PASSWORD_HASHING__ARGON2__MEMORY
int7168
spi-password-hashing--argon2--parallelism
Parallelism
CLI: --spi-password-hashing--argon2--parallelism
Env: KC_SPI_PASSWORD_HASHING__ARGON2__PARALLELISM
int1
spi-password-hashing--argon2--type
Type
CLI: --spi-password-hashing--argon2--type
Env: KC_SPI_PASSWORD_HASHING__ARGON2__TYPE
id, d, iid
spi-password-hashing--argon2--version
Version
CLI: --spi-password-hashing--argon2--version
Env: KC_SPI_PASSWORD_HASHING__ARGON2__VERSION
1.3, 1.01.3

password-policy

password-blacklist

OptionType or ValuesDefault
spi-password-policy--password-blacklist--check-interval-seconds
Interval in number of seconds when the server should check the password file for changes and reload it.
Set to 0 to disable reloading.
CLI: --spi-password-policy--password-blacklist--check-interval-seconds
Env: KC_SPI_PASSWORD_POLICY__PASSWORD_BLACKLIST__CHECK_INTERVAL_SECONDS
string60
spi-password-policy--password-blacklist--false-positive-probability
False positive probability of the bloom filter to reject a valid password.
CLI: --spi-password-policy--password-blacklist--false-positive-probability
Env: KC_SPI_PASSWORD_POLICY__PASSWORD_BLACKLIST__FALSE_POSITIVE_PROBABILITY
string0.0001

public-key-storage

infinispan

OptionType or ValuesDefault
spi-public-key-storage--infinispan--max-cache-time
Maximum interval in seconds that keys are cached when they are retrieved via all keys methods.
When all keys for the entry are retrieved there is no way to detect if a key is missing (different to the case when the key is retrieved via ID for example). In that situation this option forces a refresh from time to time. This time can be overriden by the protocol (for example using cacheDuration or validUntil in the SAML descriptor). Default 24 hours.
CLI: --spi-public-key-storage--infinispan--max-cache-time
Env: KC_SPI_PUBLIC_KEY_STORAGE__INFINISPAN__MAX_CACHE_TIME
int86400
spi-public-key-storage--infinispan--min-time-between-requests
Minimum interval in seconds between two requests to retrieve the new public keys.
The server will always try to download new public keys when a single key is requested and not found. However it will avoid the download if the previous refresh was done less than 10 seconds ago (by default). This behavior is used to avoid DoS attacks against the external keys endpoint.
CLI: --spi-public-key-storage--infinispan--min-time-between-requests
Env: KC_SPI_PUBLIC_KEY_STORAGE__INFINISPAN__MIN_TIME_BETWEEN_REQUESTS
int10

required-action

CONFIGURE_RECOVERY_AUTHN_CODES

OptionType or ValuesDefault
spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_RECOVERY_AUTHN_CODES__MAX_AUTH_AGE
String300
spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--warning_threshold
When user has smaller amount of remaining recovery codes on his account than the value configured here, account console will show warning to the user, which will recommend him to setup new set of recovery codes.
CLI: --spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--warning_threshold
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_RECOVERY_AUTHN_CODES__WARNING_THRESHOLD
Integer4

CONFIGURE_TOTP

OptionType or ValuesDefault
spi-required-action--CONFIGURE_TOTP--add-recovery-codes
If this option is enabled, the user will be required to configure recovery codes following the OTP configuration.
If the user already has recovery codes configured, NQRust-Identity will not ask for setting them up.
As a prerequisite, enable the recovery codes required action and enable recovery codes in your authentication flow.
CLI: --spi-required-action--CONFIGURE_TOTP--add-recovery-codes
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_TOTP__ADD_RECOVERY_CODES
true, falsefalse
spi-required-action--CONFIGURE_TOTP--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--CONFIGURE_TOTP--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_TOTP__MAX_AUTH_AGE
String300

TERMS_AND_CONDITIONS

OptionType or ValuesDefault
spi-required-action--TERMS_AND_CONDITIONS--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--TERMS_AND_CONDITIONS--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__TERMS_AND_CONDITIONS__MAX_AUTH_AGE
String300

UPDATE_EMAIL

OptionType or ValuesDefault
spi-required-action--UPDATE_EMAIL--email-resend-cooldown-seconds
Minimum delay in seconds before another email verification email can be sent.
CLI: --spi-required-action--UPDATE_EMAIL--email-resend-cooldown-seconds
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__EMAIL_RESEND_COOLDOWN_SECONDS
String30
spi-required-action--UPDATE_EMAIL--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--UPDATE_EMAIL--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__MAX_AUTH_AGE
String300
spi-required-action--UPDATE_EMAIL--verify-email
If enabled, the user will be forced to verify the email regardless if email verification is enabled at the realm level or not.
Otherwise, verification will be based on the realm level setting.
CLI: --spi-required-action--UPDATE_EMAIL--verify-email
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__VERIFY_EMAIL
true, falsefalse

UPDATE_PASSWORD

OptionType or ValuesDefault
spi-required-action--UPDATE_PASSWORD--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--UPDATE_PASSWORD--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_PASSWORD__MAX_AUTH_AGE
String300

UPDATE_PROFILE

OptionType or ValuesDefault
spi-required-action--UPDATE_PROFILE--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--UPDATE_PROFILE--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_PROFILE__MAX_AUTH_AGE
String300

VERIFY_EMAIL

OptionType or ValuesDefault
spi-required-action--VERIFY_EMAIL--email-resend-cooldown-seconds
Minimum delay in seconds before another email verification email can be sent.
CLI: --spi-required-action--VERIFY_EMAIL--email-resend-cooldown-seconds
Env: KC_SPI_REQUIRED_ACTION__VERIFY_EMAIL__EMAIL_RESEND_COOLDOWN_SECONDS
String30
spi-required-action--VERIFY_EMAIL--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--VERIFY_EMAIL--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__VERIFY_EMAIL__MAX_AUTH_AGE
String300

VERIFY_PROFILE

OptionType or ValuesDefault
spi-required-action--VERIFY_PROFILE--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--VERIFY_PROFILE--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__VERIFY_PROFILE__MAX_AUTH_AGE
String300

delete_credential

OptionType or ValuesDefault
spi-required-action--delete_credential--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--delete_credential--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__DELETE_CREDENTIAL__MAX_AUTH_AGE
String300

idp_link

OptionType or ValuesDefault
spi-required-action--idp_link--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--idp_link--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__IDP_LINK__MAX_AUTH_AGE
String300

update_user_locale

OptionType or ValuesDefault
spi-required-action--update_user_locale--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--update_user_locale--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_USER_LOCALE__MAX_AUTH_AGE
String300

verifiable_credential_offer

OptionType or ValuesDefault
spi-required-action--verifiable_credential_offer--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--verifiable_credential_offer--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__VERIFIABLE_CREDENTIAL_OFFER__MAX_AUTH_AGE
String300

webauthn-register

OptionType or ValuesDefault
spi-required-action--webauthn-register--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--webauthn-register--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__WEBAUTHN_REGISTER__MAX_AUTH_AGE
String300

webauthn-register-passwordless

OptionType or ValuesDefault
spi-required-action--webauthn-register-passwordless--max_auth_age
Configures the duration in seconds this action can be used after the last authentication before the user is required to re-authenticate.
This parameter is used just in the context of AIA when the kc_action parameter is available in the request, which is for instance when user himself updates his password in the account console.
CLI: --spi-required-action--webauthn-register-passwordless--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__WEBAUTHN_REGISTER_PASSWORDLESS__MAX_AUTH_AGE
String300

resource-encoding

gzip

OptionType or ValuesDefault
spi-resource-encoding--gzip--excluded-content-types
A space separated list of content-types to exclude from encoding.
CLI: --spi-resource-encoding--gzip--excluded-content-types
Env: KC_SPI_RESOURCE_ENCODING__GZIP__EXCLUDED_CONTENT_TYPES
stringimage/png image/jpeg

security-profile

default

OptionType or ValuesDefault
spi-security-profile--default--name
Name for the security configuration file to use.
File name.json is searched in classapth and conf installation folder.
CLI: --spi-security-profile--default--name
Env: KC_SPI_SECURITY_PROFILE__DEFAULT__NAME
string

single-use-object

infinispan

OptionType or ValuesDefault
spi-single-use-object--infinispan--persist-revoked-tokens
If revoked tokens are stored persistently across restarts
CLI: --spi-single-use-object--infinispan--persist-revoked-tokens
Env: KC_SPI_SINGLE_USE_OBJECT__INFINISPAN__PERSIST_REVOKED_TOKENS
true, falsetrue

remote

OptionType or ValuesDefault
spi-single-use-object--remote--persist-revoked-tokens
If revoked tokens are stored persistently across restarts
CLI: --spi-single-use-object--remote--persist-revoked-tokens
Env: KC_SPI_SINGLE_USE_OBJECT__REMOTE__PERSIST_REVOKED_TOKENS
true, falsetrue

sticky-session-encoder

infinispan

OptionType or ValuesDefault
spi-sticky-session-encoder--infinispan--should-attach-route
If the route should be attached to cookies to reflect the node that owns a particular session.
CLI: --spi-sticky-session-encoder--infinispan--should-attach-route
Env: KC_SPI_STICKY_SESSION_ENCODER__INFINISPAN__SHOULD_ATTACH_ROUTE
true, falsetrue

remote

OptionType or ValuesDefault
spi-sticky-session-encoder--remote--should-attach-route
If the route should be attached to cookies to reflect the node that owns a particular session.
CLI: --spi-sticky-session-encoder--remote--should-attach-route
Env: KC_SPI_STICKY_SESSION_ENCODER__REMOTE__SHOULD_ATTACH_ROUTE
true, falsetrue

storage

ldap

OptionType or ValuesDefault
spi-storage--ldap--secure-referral
Allow only secure LDAP referrals (deprecated)
CLI: --spi-storage--ldap--secure-referral
Env: KC_SPI_STORAGE__LDAP__SECURE_REFERRAL
true, falsetrue

truststore

file

OptionType or ValuesDefault
spi-truststore--file--file
DEPRECATED: The file path of the trust store from where the certificates are going to be read from to validate TLS connections.
CLI: --spi-truststore--file--file
Env: KC_SPI_TRUSTSTORE__FILE__FILE
string
spi-truststore--file--hostname-verification-policy
DEPRECATED: The hostname verification policy.
CLI: --spi-truststore--file--hostname-verification-policy
Env: KC_SPI_TRUSTSTORE__FILE__HOSTNAME_VERIFICATION_POLICY
ANY, WILDCARD, STRICT, DEFAULTDEFAULT
spi-truststore--file--password
DEPRECATED: The trust store password.
CLI: --spi-truststore--file--password
Env: KC_SPI_TRUSTSTORE__FILE__PASSWORD
string
spi-truststore--file--type
DEPRECATED: Type of the truststore.
If not provided, the type would be detected based on the truststore file extension or platform default type.
CLI: --spi-truststore--file--type
Env: KC_SPI_TRUSTSTORE__FILE__TYPE
string

user-profile

declarative-user-profile

OptionType or ValuesDefault
spi-user-profile--declarative-user-profile--admin-read-only-attributes
Array of regular expressions to identify fields that should be treated read-only so administrators can’t change them.
CLI: --spi-user-profile--declarative-user-profile--admin-read-only-attributes
Env: KC_SPI_USER_PROFILE__DECLARATIVE_USER_PROFILE__ADMIN_READ_ONLY_ATTRIBUTES
MultivaluedString
spi-user-profile--declarative-user-profile--max-email-local-part-length
To set user profile max email local part length
CLI: --spi-user-profile--declarative-user-profile--max-email-local-part-length
Env: KC_SPI_USER_PROFILE__DECLARATIVE_USER_PROFILE__MAX_EMAIL_LOCAL_PART_LENGTH
String
spi-user-profile--declarative-user-profile--read-only-attributes
Array of regular expressions to identify fields that should be treated read-only so users can’t change them.
CLI: --spi-user-profile--declarative-user-profile--read-only-attributes
Env: KC_SPI_USER_PROFILE__DECLARATIVE_USER_PROFILE__READ_ONLY_ATTRIBUTES
MultivaluedString

user-session-persister

jpa

OptionType or ValuesDefault
spi-user-session-persister--jpa--expiration-batch
Sets the size of the expiration batch, i.
e., the number of expired sessions to remove per delete statement.
CLI: --spi-user-session-persister--jpa--expiration-batch
Env: KC_SPI_USER_SESSION_PERSISTER__JPA__EXPIRATION_BATCH
Integer512

user-sessions

infinispan

OptionType or ValuesDefault
spi-user-sessions--infinispan--max-batch-size
Maximum size of a batch (only applicable to persistent sessions
CLI: --spi-user-sessions--infinispan--max-batch-size
Env: KC_SPI_USER_SESSIONS__INFINISPAN__MAX_BATCH_SIZE
int4
spi-user-sessions--infinispan--offline-client-session-cache-entry-lifespan-override
Override how long offline client sessions should be kept in memory in seconds (deprecated, to be removed in NQRust-Identity 27)
CLI: --spi-user-sessions--infinispan--offline-client-session-cache-entry-lifespan-override
Env: KC_SPI_USER_SESSIONS__INFINISPAN__OFFLINE_CLIENT_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE
int
spi-user-sessions--infinispan--offline-session-cache-entry-lifespan-override
Override how long offline user sessions should be kept in memory in seconds (deprecated, to be removed in NQRust-Identity 27)
CLI: --spi-user-sessions--infinispan--offline-session-cache-entry-lifespan-override
Env: KC_SPI_USER_SESSIONS__INFINISPAN__OFFLINE_SESSION_CACHE_ENTRY_LIFESPAN_OVERRIDE
int
spi-user-sessions--infinispan--session-expiration-period
Sets the expiration task run period, to remove the expired session.
CLI: --spi-user-sessions--infinispan--session-expiration-period
Env: KC_SPI_USER_SESSIONS__INFINISPAN__SESSION_EXPIRATION_PERIOD
int
spi-user-sessions--infinispan--use-batches
Enable or disable batch writes to the database.
Enabled by default with the persistent-user-sessions Feature
CLI: --spi-user-sessions--infinispan--use-batches
Env: KC_SPI_USER_SESSIONS__INFINISPAN__USE_BATCHES
true, falsefalse
spi-user-sessions--infinispan--use-caches
Enable or disable caches.
Enabled by default unless the external feature to use only external remote caches is used
CLI: --spi-user-sessions--infinispan--use-caches
Env: KC_SPI_USER_SESSIONS__INFINISPAN__USE_CACHES
true, false

remote

OptionType or ValuesDefault
spi-user-sessions--remote--batch-size
Batch size when streaming session from the remote cache
CLI: --spi-user-sessions--remote--batch-size
Env: KC_SPI_USER_SESSIONS__REMOTE__BATCH_SIZE
int1024
spi-user-sessions--remote--max-retries
The maximum number of retries if an error occurs.
A value of zero or less disable any retries.
CLI: --spi-user-sessions--remote--max-retries
Env: KC_SPI_USER_SESSIONS__REMOTE__MAX_RETRIES
int10
spi-user-sessions--remote--retry-base-time
The base back-off time in milliseconds.
CLI: --spi-user-sessions--remote--retry-base-time
Env: KC_SPI_USER_SESSIONS__REMOTE__RETRY_BASE_TIME
int10

well-known

oauth-authorization-server

OptionType or ValuesDefault
spi-well-known--oauth-authorization-server--include-client-scopes
If client scopes should be used to calculate the list of supported scopes.
CLI: --spi-well-known--oauth-authorization-server--include-client-scopes
Env: KC_SPI_WELL_KNOWN__OAUTH_AUTHORIZATION_SERVER__INCLUDE_CLIENT_SCOPES
true, falsetrue
spi-well-known--oauth-authorization-server--openid-configuration-override
The file path from where the metadata should be loaded from.
You can use an absolute file path or, if the file is in the server classpath, use the classpath: prefix to load the file from the classpath.
CLI: --spi-well-known--oauth-authorization-server--openid-configuration-override
Env: KC_SPI_WELL_KNOWN__OAUTH_AUTHORIZATION_SERVER__OPENID_CONFIGURATION_OVERRIDE
string

openid-configuration

OptionType or ValuesDefault
spi-well-known--openid-configuration--include-client-scopes
If client scopes should be used to calculate the list of supported scopes.
CLI: --spi-well-known--openid-configuration--include-client-scopes
Env: KC_SPI_WELL_KNOWN__OPENID_CONFIGURATION__INCLUDE_CLIENT_SCOPES
true, falsetrue
spi-well-known--openid-configuration--openid-configuration-override
The file path from where the metadata should be loaded from.
You can use an absolute file path or, if the file is in the server classpath, use the classpath: prefix to load the file from the classpath.
CLI: --spi-well-known--openid-configuration--openid-configuration-override
Env: KC_SPI_WELL_KNOWN__OPENID_CONFIGURATION__OPENID_CONFIGURATION_OVERRIDE
string

workflow

default

OptionType or ValuesDefault
spi-workflow--default--executor-task-timeout
The time in milliseconds before a workflow task is marked as timed out .
CLI: --spi-workflow--default--executor-task-timeout
Env: KC_SPI_WORKFLOW__DEFAULT__EXECUTOR_TASK_TIMEOUT
long5000