This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Toggle Touch ID Enrollment

Toggle the simulator being enrolled to accept touchId (iOS Simulator only)

Example Usage

driver.toggleTouchIDEnrollment(true);

self.driver.toggle_touch_id_enrollment()

// webdriver.io example
driver.toggleEnrollTouchId(true);

// wd example
await driver.toggleTouchIdEnrollment();

# ruby_lib example
toggle_touch_id_enrollment

# ruby_lib_core example
@driver.toggle_touch_id_enrollment

// TODO C# sample

Description

To enable this feature, the allowTouchIdEnroll desired capability must be set to true. When allowTouchIdEnroll is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state.

Another way to enable touch id is by using mobile: enrollBiometric. More info here.

This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/simulator/toggle_touch_id_enrollment

URL Parameters

JSON Parameters

Response

null

See Also

• JSONWP Specification