22.23. 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 （デフォルト）または任意の 整数

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--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 （デフォルト）または文字 列

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