Legacy | Set Sensor Authentication

  • Command: sensorAuthentication

  • Subcommand: set

  • Supported Platforms: Native (legacy), UFT (legacy), Appium 

    All commands must be executed using the same framework. Sharing the execution ID between different frameworks is not possible. This means that if you work with a Selenium/Appium driver, you need to call the commands using the Selenium/Appium driver (or, in the case of Reporting commands, through the Reporting SDK that works with the driver) and not as part of a UFT test or another framework.

  • Supported OS: android, iOS 9+

Description

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 Value Default Description
deviceID*     The device for this command.
name     The application name as it is displayed on the device screen.
identifier     The identifier of the application.
resultAuth

success (Success)

fail (Fail)

Success The authentication result returned by the fingerprint checking procedure.
errorType

authFailed (Auth Failed)

userCancel (User Cancel)

userFallback (User Fallback)

systemCancel (System Cancel)

lockOut (Lock Out)

Auth Failed

The Error type is used when the Authentication result is false to indicate the reason that the authentication failed. The default is Auth Failed.

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.

* Mandatory parameter

Request

Copy

Request

https://mycloud.perfectomobile.com/services/executions/john@perfectomobile.com_controller_16-12-08_08_14_17_415?operation=command&securityToken=<your_token>&command=sensorAuthentication&subcommand=set&param.deviceId=6BA14A93C1DE5748D3E65C555CCE67FCC9EBD4CA&param.name=myApp