An object describing an authenticator.

Hierarchy

  • Authenticator

Properties

aaid: string

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

registration: RegistrationInfo

The object containing the registration information of this Authenticator.

userEnrollment: UserEnrollment

The user enrollment information.

If this is an OS based authenticator (such as the fingerprint 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 either a PinEnroller or PasswordEnroller.

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

If an authenticator that is not supported is provided through AuthenticatorSelector for registration or authentication operations, an OperationError will be returned as a result of the operation.

isSupportedByHardware: boolean

Returns whether the device has hardware supporting this authenticator or not. For example if this is a fingerprint authenticator and the mobile device where the SDK is running does not have a fingerprint sensor, this method will return false.

If an authenticator that is not supported is provided through AuthenticatorSelector for registration or authentication operations, an OperationError will be returned as a result of the operation.

Methods

Generated using TypeDoc