The object containing the user enrollment information for an authenticator whose credentials are managed by the operating system (like the fingerprint authenticator). In this case, there is no notion of Account: either the authenticator is enrolled at the operating system level (for all users) or not.

Hierarchy

Properties

isOSEnrolled: boolean

Returns true if the user is enrolled to the OS based authenticator, false otherwise.

isEnrolledWithClass2OrClass3Sensor: boolean

For the biometric authenticator, returns true if the user is enrolled in the OS with at least one Class 2 (formerly weak) or Class 3 (formerly strong) biometric sensor, false otherwise.

For the PIN, password and fingerprint authenticators, it returns the same value as isEnrolled.

IMPORTANT
This property is Android specific and will be ignored by iOS native plugin.

This method must be used on Android instead of isEnrolled if Class 2 biometric sensors were allowed during registration of a biometric authenticator. If no Class 2 biometric sensor is allowed, this method will return the same value as isEnrolled.

Methods

  • Tells whether a given user is enrolled or not.

    Parameters

    • username: string

      the username.

    Returns boolean

    true if the user is enrolled, false otherwise.

Generated using TypeDoc