Authenticator

public protocol Authenticator : Encodable, Equatable

An object describing an authenticator.

  • The “Authenticator Attestation ID” (AAID), which identifies the type and batch of the authenticator.

    Declaration

    Swift

    var aaid: String { get }

  • Returns the object containing the registration information for the current Authenticator.

    Declaration

    Swift

    var registration: (any RegistrationInfo)? { get }

  • Returns the user enrollment information.

    If this is an OS based authenticator, the user is enrolled when fingerprints are defined at the operating system level. If the authenticator is managed at the SDK level (PIN or password), the credentials are defined during registration using a PinEnroller or PasswordEnroller.

    If the user is not enrolled in a system managed authenticator (FaceID, TouchID), the authenticator cannot be used to do a registration or an authentication.

    Declaration

    Swift

    var userEnrollment: (any UserEnrollment)? { get }

  • Returns true if the device has hardware supporting this authenticator, false otherwise.

    Declaration

    Swift

    var isSupportedByHardware: Bool { get }