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



// example

// wd example
await driver.toggleTouchIdEnrollment();

# ruby_lib example

# ruby_lib_core example

// TODO C# sample


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., or has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation None None None
Android UiAutomator2 None None None
Espresso None None None
UiAutomator None None None
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


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

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
enabled boolean If true, enable, if falsey disable, otherwise toggle (optional)



See Also