Interface IMfaSettings

All Superinterfaces:
Serializable
public interface IMfaSettings extends Serializable
Interface for accessing the Multi-Factor Authentication (MFA) settings of the system.
Since:
8.4.0
Author:
Norman Lorenz

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaxMfaTempTokensPerUser()
    Returns the maximum number of temporary MFA tokens that can be created for a single user.
    int
    getMaxVerifyAttemptsPerMfaTempToken()
    Returns the maximum number of attempts a user has to enter the correct MFA code when using a temporary token.
    int
    getMfaSaveDays()
    Returns the number of days a Multi-Factor Authentication (MFA) may be saved before it needs to be re-verified.
    Duration
    getMfaTempTokenValidityDuration()
    Returns the duration for which a temporary MFA token is valid.
    boolean
    isAllowUserRecovery()
    Returns whether the user may be able to recover their user account if the MFA token was lost.
    boolean
    isMfaForced()
    Returns whether Multi-Factor Authentication (MFA) is enabled (forced) for every user in the system.

  • Method Details

    • getMaxMfaTempTokensPerUser

      int getMaxMfaTempTokensPerUser()
      Returns the maximum number of temporary MFA tokens that can be created for a single user.
      Returns:
      the maximum number of temporary tokens per user.

    • getMaxVerifyAttemptsPerMfaTempToken

      int getMaxVerifyAttemptsPerMfaTempToken()
      Returns the maximum number of attempts a user has to enter the correct MFA code when using a temporary token.
      Returns:
      the maximum number of attempts allowed for a temporary MFA token when verifying the user via an MFA code.

    • getMfaSaveDays

      int getMfaSaveDays()
      Returns the number of days a Multi-Factor Authentication (MFA) may be saved before it needs to be re-verified.
      Returns:
      the number of days until re-verification is required. 0 means that the MFA can't be saved and users must verify their MFA every time they log in.

    • getMfaTempTokenValidityDuration

      Duration getMfaTempTokenValidityDuration()
      Returns the duration for which a temporary MFA token is valid.
      Returns:
      the duration of the temporary token validity.
      See Also:

    • isAllowUserRecovery

      boolean isAllowUserRecovery()
      Returns whether the user may be able to recover their user account if the MFA token was lost. If false the user needs to turn to the system administrator to reset the MFA.
      Returns:
      true if user recovery is allowed, false otherwise.

    • isMfaForced

      boolean isMfaForced()
      Returns whether Multi-Factor Authentication (MFA) is enabled (forced) for every user in the system.
      Returns:
      true if MFA is forced, false otherwise.