Biometrics

Data class used for wrapping parameters used with Biometrics authentication flow

Data class used for wrapping parameters used to create a biometric prompt

Data class used for wrapping parameters used with Biometrics registration flow

Indicates if the biometric sensor is available, and provides a reasoning if not

If a valid biometric registration exists, this method confirms the current device owner via the device's built-in biometric reader and returns an updated session object by either starting a new session or adding the biometric factor to an existing session.

Indicates if there is an existing biometric registration on device.

Indicates if the device is device has a reliable version of the Android KeyStore. If it does not, there may be issues creating encryption keys, as well as implications on where these keys are stored. The safest approach is to not offer biometrics if this returns false, but it is possible to force a registration with an unreliable KeyStore.

When a valid/active session exists, this method will add a biometric registration for the current user. The user will later be able to start a new session with biometrics or use biometrics as an additional authentication factor.

Clears existing biometric registrations stored on device. Useful when removing a user from a given device. Returns true if the registration was successfully removed from device.