Authenticators

Kotlin |Java

interface Authenticators

android.hardware.biometrics.BiometricManager.Authenticators

Types of authenticators, defined at a level of granularity supported by BiometricManager and BiometricPrompt.

Types may combined via bitwise OR into a single integer representing multiple authenticators (e.g. DEVICE_CREDENTIAL | BIOMETRIC_WEAK).

Summary

Constants
static Int	`BIOMETRIC_STRONG` Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for
static Int	`BIOMETRIC_WEAK` Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for
static Int	`DEVICE_CREDENTIAL` The non-biometric credential used to secure the device (i.e., PIN, pattern, or password).
static Int	`IDENTITY_CHECK` The bit is used to request for Identity Check.

Constants

BIOMETRIC_STRONG

Added in API level 30

static val BIOMETRIC_STRONG: Int

Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 3 (formerly Strong), as defined by the Android CDD.

This corresponds to KeyProperties.AUTH_BIOMETRIC_STRONG during key generation.

Value: 15

See Also

android.security.keystore.KeyGenParameterSpec.Builder

BIOMETRIC_WEAK

Added in API level 30

static val BIOMETRIC_WEAK: Int

Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 2 (formerly Weak), as defined by the Android CDD.

Note that this is a superset of BIOMETRIC_STRONG and is defined such that BIOMETRIC_STRONG | BIOMETRIC_WEAK == BIOMETRIC_WEAK.

Value: 255

DEVICE_CREDENTIAL

Added in API level 30

static val DEVICE_CREDENTIAL: Int

The non-biometric credential used to secure the device (i.e., PIN, pattern, or password). This should typically only be used in combination with a biometric auth type, such as BIOMETRIC_WEAK.

This corresponds to KeyProperties.AUTH_DEVICE_CREDENTIAL during key generation.

Value: 32768

See Also

android.security.keystore.KeyGenParameterSpec.Builder

IDENTITY_CHECK

Added in API level Baklava

static val IDENTITY_CHECK: Int

The bit is used to request for Identity Check. Identity Check is a feature which requires class 3 biometric authentication to access sensitive surfaces when the device is outside trusted places.

The requirements to trigger Identity Check are as follows: 1. User must have enabled the toggle for Identity Check in settings 2. User must have enrollments for at least one BIOMETRIC_STRONG sensor 3. The device is determined to be in a high risk environment, for example if it is outside of the user's trusted locations or fails to meet similar conditions. 4. The Identity Check requirements bit must be true

If all the above conditions are satisfied, only BIOMETRIC_STRONG sensors will be eligible for authentication, and device credential fallback will be dropped.

Value: 65536