22.24. required-action

spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_RECOVERY_AUTHN_CODES__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--warning_threshold

ユーザーのアカウントにある残りのリカバリーコードの数が、ここで設定した値よりも少ない場合、アカウントコンソールにユーザーへの警告が表示され、新しいリカバリーコードセットをセットアップするように推奨します。

CLI: --spi-required-action--CONFIGURE_RECOVERY_AUTHN_CODES--warning_threshold
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_RECOVERY_AUTHN_CODES__WARNING_THRESHOLD

4 (デフォルト) または任意の Integer

spi-required-action--CONFIGURE_TOTP--add-recovery-codes

このオプションを有効にすると、ユーザーは OTP 設定に続いて回復コードを設定する必要が生じます。

ユーザーがすでにリカバリーコードを設定している場合、Keycloak はそれらのセットアップを求めません。前提条件として、リカバリーコードの必須アクションを有効にし、認証フローでリカバリーコードを有効にします。

CLI: --spi-required-action--CONFIGURE_TOTP--add-recovery-codes
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_TOTP__ADD_RECOVERY_CODES

true、false (デフォルト)

spi-required-action--CONFIGURE_TOTP--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--CONFIGURE_TOTP--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__CONFIGURE_TOTP__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--TERMS_AND_CONDITIONS--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--TERMS_AND_CONDITIONS--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__TERMS_AND_CONDITIONS__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--UPDATE_EMAIL--email-resend-cooldown-seconds

別のメール確認メールを送信するまでの最小遅延秒数。

CLI: --spi-required-action--UPDATE_EMAIL--email-resend-cooldown-seconds
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__EMAIL_RESEND_COOLDOWN_SECONDS

30 (デフォルト) または任意の String

spi-required-action--UPDATE_EMAIL--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--UPDATE_EMAIL--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--UPDATE_EMAIL--verify-email

有効にすると、レルムレベルでメール検証が有効になっているかどうかに関係なく、ユーザーはメールを強制的に検証することになります。

それ以外の場合、検証はレルムレベルの設定に基づいて行われます。

CLI: --spi-required-action--UPDATE_EMAIL--verify-email
Env: KC_SPI_REQUIRED_ACTION__UPDATE_EMAIL__VERIFY_EMAIL

true、false (デフォルト)

spi-required-action--UPDATE_PASSWORD--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--UPDATE_PASSWORD--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_PASSWORD__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--UPDATE_PROFILE--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--UPDATE_PROFILE--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_PROFILE__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--VERIFY_EMAIL--email-resend-cooldown-seconds

別のメール確認メールを送信するまでの最小遅延秒数。

CLI: --spi-required-action--VERIFY_EMAIL--email-resend-cooldown-seconds
Env: KC_SPI_REQUIRED_ACTION__VERIFY_EMAIL__EMAIL_RESEND_COOLDOWN_SECONDS

30 (デフォルト) または任意の String

spi-required-action--VERIFY_EMAIL--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--VERIFY_EMAIL--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__VERIFY_EMAIL__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--VERIFY_PROFILE--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--VERIFY_PROFILE--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__VERIFY_PROFILE__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--delete_credential--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--delete_credential--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__DELETE_CREDENTIAL__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--idp_link--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--idp_link--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__IDP_LINK__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--update_user_locale--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--update_user_locale--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__UPDATE_USER_LOCALE__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--webauthn-register--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--webauthn-register--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__WEBAUTHN_REGISTER__MAX_AUTH_AGE

300 (デフォルト) または任意の String

spi-required-action--webauthn-register-passwordless--max_auth_age

最後の認証後、ユーザーが再認証を要求されるまでにこのアクションを使用できる期間を秒単位で設定します。

このパラメーターは、リクエストで kc_action パラメーターが使用可能な場合、つまり、ユーザー自身がアカウントコンソールでパスワードを更新する場合などに、AIA のコンテキストでのみ使用されます。

CLI: --spi-required-action--webauthn-register-passwordless--max_auth_age
Env: KC_SPI_REQUIRED_ACTION__WEBAUTHN_REGISTER_PASSWORDLESS__MAX_AUTH_AGE

300 (デフォルト) または任意の String