PinAuthenticatorProtectionStatus

public enum PinAuthenticatorProtectionStatus : Equatable, Encodable

The object describing the PIN authenticator protection status. It provides information regarding how many retries are available for the end user before locking the authenticator.

  • The authenticator is unlocked and can be used.

    Declaration

    Swift

    case Unlocked

  • An invalid PIN was provided previously. This may imply that an attacker is trying to use the PIN authenticator.

    Declaration

    Swift

    case LastAttemptFailed(remainingTries: Int, coolDownTimeInSeconds: Int)

    Parameters

    remainingTries

    The number of remaining retries available.
    coolDownTimeInSeconds

    The time that must be passed before the user can try to provide credentials again. If the value is 0, it means that no cool-down is required, and that a new PIN can be provided immediately.

  • The authenticator is locked and cannot be used.

    Declaration

    Swift

    case LockedOut

  • Returns a descriptive text which can be used information purposes about the current state of the PIN protection status. Containing information about the remaining retries and the possible cool-down time that has to pass before the next try

    Declaration

    Swift

    var description: String { get }