FingerprintAuthenticator


Purpose

Enables you to implement support for user credentials secured by the fingerprint reader. This functionality is available on selected devices.

An instance of the FingerprintAuthenticator object is created by calling the authenticator method.

The FingerprintAuthenticator object and its methods replace the TouchID API. The following compatibility layer has been created to support apps that use the deprecated API.

Note

On Android, the FingerprintAuthenticator object is not available for system versions older than Android 6.

Old method name New method name
TouchId.checkAvailability() authenticator.checkAvailability()
TouchId.saveCredentials() authenticator.create()
TouchId.getCredentials() authenticator.authenticate()
TouchId.deleteCredentials() authenticator.remove()

Note

The fingerprint reader functionality is active once it has been activated in the device's system settings. Check your system settings and make sure that the functionality is active.

Module

This object belongs to the Authentication product module.

Methods

Name Description
checkAvailability

Checks if hardware is available that allows for fingerprint authentication and if a fingerprint has been enrolled.

create

Saves a JSON object in the keychain. Does not require authentication.

authenticate

Retrieves the JSON object from a fingerprint-secured keychain. Data retrieval requires that the user authenticates with the enrolled fingerprint.

remove

Deletes the JSON object from a fingerprint-secured keychain.

Related topics

Authentication
Legal notice | Copyright © 2018 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...