Set sensor authentication command

Injects the authentication reply for a sensor authentication check performed by the application (such as fingerprint or faceId) on supported devices.

The command should be activated by the automation script at the point that the target application presents a popup window indicating that the application is trying to retrieve information from the sensor reader.

The application must have been installed with sensor instrumentation enabled. 

To use this command, one of the two application identifiers is required. For information on retrieving the application identifier, see Application identifier.

Parameters

Name Type Possible values Description

Device ID*

String

 

The device for this command. By default, this is the device under test (DUT).

Application name

String

 

The application name as it is displayed on the screen.

Application identifier

String

 

The identifier of the application.

Authentication result

String

Success | Fail

The authentication result returned by the check fingerprint procedure.

Error type

String

Auth Failed | User Cancel | User Fallback | System Cancel | Lock Out

The Error type that is used when the authentication result is false to indicate the reason why the authentication failed, where:

  • Auth Failed indicates that the fingerprint was not recognized.

  • User Cancel indicates that the user canceled the authentication.

  • User Fallback indicates that user wishes to supply a fallback authentication, for example a password.

  • System Cancel indicates that the system canceled the authentication.

  • Lock Out indicates multiple failures and application should lock the account.

Comment

String

 

Adds a comment to the script

On-fail Result*

Condition

Ignore | Break | Continue | Abort | Catch

The behavior when the command fails.

* Mandatory parameter