MDM Integration: VMware Workspace ONE (Airwatch)

NOTE: Applies to iOS and Android devices.

GroundControl has deep integration with VMware Workspace ONE (formerly AirWatch). The instructions below describe how to set up GroundControl to use AirWatch APIs.

For iOS devices you may optionally add an Enrollment Profile for touch-free enrollments of non-DEP devices.

API Integration

API integration adds many additional features to customize your Workflows, including unenroll-before-enroll, assigning organization groups, setting friendly names, and more.

iOS Devices — API Integration is recommended for both DEP and non-DEP enrollments for iOS devices.
Android Devices — API Integration is required for Android enrollments.

Android Requirements

The Imprivata Locker Android app must be granted Lock Task permissions in the MDM.
The Locker app must be added to the allowlist in your MDM.

Step 1: Configure GroundControl

In GroundControl, navigate to Admin > MDMs. Click + Add, and select AirWatch.
Switch the API Integration setting to ON. Click Configure.
In the configuration dialog, add API settings that you obtain from the Workspace ONE admin console.

Step 2: Enable REST APIs in Workspace ONE

In your Workspace ONE console, visit Groups & Settings > All Settings > System > Advanced > API > REST API > General.
Ensure that Enable API Access is selected.
Add a new API key, and label it “GroundControl”.
Copy the newly created API key and paste it into GroundControl’s API Key field.
Enter the hostname of the REST API URL, for example “as700.awmdm.com”. Do not include “https” or a trailing slash.
NOTE: This may be different from your AW console URL. See VMware KB 82724 for more information.
After enabling APIs, create a dedicated administrator account for API authentication, ensuring the administrator has a role of “Console Administrator” or above. Then, select an authentication method using Option 1 or 2 below.

Option 1: Authenticate with user and certificate

Navigate to the Authentication tab. Ensure Certificate authentication is enabled.
In Accounts > Administrators > List View, select or create an AirWatch administrator account to use with GroundControl. You can use a Basic or Directory account.
To enable API access for one of your administrator accounts, edit the administrator and click the API tab.
Select Certificates, then enter a Certificate password and click Generate Client Certificate.
Export Client Certificate and click Save.
In GroundControl, upload the certificate, enter admin username and the certificate password you just created.
Click Test to confirm connection has been established. Click Save.

Important: If the API admin user account is locked, authentication will fail. Make sure the admin account is unlocked by resetting the user’s password.

If the API admin user’s password expires, API integration will continue to work as expected.

Option 2: Authenticate with username and password

Navigate to the Authentication tab. Ensure Basic authentication is enabled.
In Accounts > Administrators > List View, select or create an AirWatch administrator account to use with GroundControl. You can use a Basic or Directory account.
Note: If using this method, we recommend a dedicated directory account for GroundControl, and using certificate based authentication as Workspace ONE may enforce a periodic password change for Basic users.
To enable API access for one of your administrator accounts, edit the administrator, and click the API tab. Make sure Basic authentication is enabled.
In the Roles tab, ensure the administrator has a role of Console Administrator or above.
Important: Each Administrator must log in once to the Workspace ONE console to accept the terms & conditions.
Enter this administrator username and password in GroundControl.
Click Test to confirm connection has been established. Click Save.

Step 3: Configure Android Locker App (Android only)

Applies to Android devices only.

Step 3a: Configure the App Config in Workspace ONE

In GroundControl, in the Android Locker App Configuration section, click Show details.
Copy the AppConfig values from the Android Locker App Configuration section using the copy to clipboard icon next to each item.
1. GroundControl MDM ID
2. GroundControl Server
3. Device Identifier.
  NOTE: The Device Identifier AppConfig value is formatted differently, depending on your MDM. You will use these values when configuring AppConfig values in Workspace ONE.
In the Workspace ONE UEM console, specify the user groups that will receive the Imprivata Locker (Android) app.
1. On the distribution screen, name the assignment and in the Assignment Groups field, enter the name of the user group or smart group.
2. Configure how to deploy Imprivata Locker. Select Auto.
From the menu on the left, click Application Configuration.
Add three new keys for the AppConfig and paste the values you copied from the GroundControl MDM tab:
1. GroundControl MDM ID
2. GroundControl Server
3. Device Identifier
Save the change, then click Save and Publish, then Publish.

Step 3b: Configure Lock Task and Add Locker App to Allowlist

To configure lock task mode and add the Locker app to the allowlist:

In the Workspace ONE UEM console, expand the Lock Task Mode section to specify the lock task mode settings.
From the Allowlisted Apps field, select Imprivata Locker.
For the Home Button, select Disabled.
For the Global Actions, select Enabled. This allows device reboot.
Set System Info in status bar to Disabled.
For the Lock Screen, select Disabled.

Step 3c: Configure a Lock Task Profile

To enable lock task permissions, deploy a lock task profile:

In the Workspace ONE UEM console, navigate to Resources > Profiles > Add profile > Setup Custom Settings.

 <characteristic uuid="0bb1b271-b958-496d-a29b-6d7eb97ee0a1" type="com.airwatch.android.androidwork.kiosk" target="2">
    <parm name="packages" value="com.samsung.android.incallui,com.imprivata.locker,com.imprivata.imda,com.imprivata.notify,com.imprivata.notify.doubler,com.symbol.wfc.voice,com.android.nfc" type="string" />
    <parm name="allowLockTaskHomeScreen" value="False" />
    <parm name="allowLockTaskOverview" value="False" />
    <parm name="allowLockTaskNotifications" value="False" />
    <parm name="allowLockTaskGlobalActions" value="True" />
    <parm name="allowLockTaskSystemInfo" value="False" />
    <parm name="allowLockTaskKeyguard" value="False" />
</characteristic>

Step 4: Non DEP Device Enrollment (iOS only)

Applies only to iOS devices.

Enrollment profiles are not required for DEP enrollments. If you have non-DEP devices to enroll, follow these instructions to obtain an enrollment profile from AirWatch.

Step 4a: Select an Enrollment Organization Group

Non-DEP devices will enroll devices into this group. You may use API integration to move devices into any child organization group of the enrollment group. Note you can not use APIs to move devices “sideways” into another group, only “down.” For maximum flexibility, we recommend you use the root organization group for enrollment.

Step 4b: Create a Staging User

AirWatch requires that every device is associated with a user. You will need to create a user (not administrator) to associate devices. Create this user in your staging organization group. You only need to enter the required fields. The password can be anything, as it will never be used.

If you are sharing devices, then this configuration is sufficient. All devices will belong to the same staging user. But if you are staging devices for later one-to-one assignment, select the Enable Device Staging box. With this box checked, the device may be re-assigned to a particular user later in the process.

Click Save when done.

Step 4c: Export the Enrollment Configuration Profile

The section to download the enrollment configuration profile is buried deep within Settings. Go to Devices > Device Settings > Apple > Automated Enrollment.

Ensure the correct staging organization group is selected at the top of the screen.

Enable Automated Enrollment, and Apple iOS.
For shared devices, set the staging mode to “None.” To stage 1-1 deployments, select “Single User.”
Select the correct Default Staging User.
Click Export to download a configuration profile containing this enrollment information. (If you are on a Mac, your Mac will attempt to install this configuration profile. Click Cancel or you will enroll your Mac into Workspace ONE!)
Locate the downloaded configuration profile on your Mac or PC. Upload this file into the AirWatch setting within GroundControl.