Imprivata MDA Requirements
Imprivata Mobile Device Access extends Imprivata authentication management and single sign–on to mobile devices and apps. Configuring Imprivata MDA requires you to:
-
Review the required Android device settings and permissions.
-
Review the required MDM solution for your environment.
-
Review the AppConfig reference for key/value pairs required for configuring Imprivata MDA.
-
Configure your MDM to deploy the Imprivata MDA app to your devices and configure application specific settings.
Imprivata MDA is a separately licensed feature of Imprivata Enterprise Access Management.
Before You Begin
Review the following before deploying Imprivata MDA.
Before you begin:
-
Review the list of workflows, applications, and supported devices for Imprivata MDA.
Imprivata MDA requires that you use an Mobile Device Management (MDM) solution to deploy the Imprivata MDA app and other apps to your mobile devices.
For more information, see Deploy Imprivata MDA via your MDM
For a list of supported MDMs, see Supported Components.
Imprivata MDA requires specific device settings and permissions. The following table details these requirements:
| Setting | Requirement |
|---|---|
| Android Device Settings | |
|
Android native lock screen |
Disabled, if not using the Imprivata MDA Countdown to Lock feature. |
| Screen timeout | Set the value to the maximum time allowed by the device. Imprivata MDA controls this behavior. |
| Native Launcher |
|
| Power saving mode | Disabled. |
| Wireless connection |
|
| Autofill Service |
Required if you plan to use the Google Autofill Framework. Set the Autofill Service to use Imprivata MDA. For more information, see Configuring Imprivata Mobile Device Access with the Google Autofill Framework |
| Android Permissions | |
| Access to the Device ID is required. |
Required. Imprivata MDA requires access to the device ID to report on individual login and device activity. NOTE:
If your MDM cannot enable this permission, you can provide access the first time you launch Imprivata MDA on the device. |
| Draw over (overlay) other apps |
Required. The Draw over (overlay) other apps permission must be enabled manually on each device after the installation. |
| Activate the Accessibility Service |
Required. The Accessibility Service must be enabled manually on each device after the installation. |
| Read and access notifications |
Required. Permission to read and access notifications must be enabled manually on each device after the installation. |
| App must be granted Lock Task Permissions |
|
|
The following Android packages cannot be restricted:
|
Consider the following:
|
|
The app must be configured with the following:
|
Consider the following:
|
If you are an existing Imprivata Enterprise Access Management customer, the badges currently deployed to your users may not support the necessary NFC frequency required by the mobile devices. Mobile devices leverage NFC Technology which is the 13.56 MHz MIFARE NFC Frequency.
If your current badges do not support this frequency, there are two options available:
-
Replace existing badges with new badges that support dual frequency (both 125 kHz and 13.56 MHz).
-
Use stickers (sometimes called "pucks") which can be attached to a badge to allow for 13.56 MHz frequency to be read.
The following tables provide a reference for AppConfig key/value pairs used to configure Imprivata MDA with Mobile Device Management (MDM) platforms.
Depending on your MDM's interface, some AppConfig keys are displayed with specific UI labels.
See the Notes column in the table below for specifics.
Required AppConfig Keys
These keys are required by Imprivata MDA.
| AppConfig Configuration Key | AppConfig Value Type |
AppConfig Value |
Description | Notes |
|---|---|---|---|---|
| ServerIP | String | <Imprivata appliance address> | The server address of the Imprivata appliance. |
Depending on your MDM interface, this may appear as Server address or Enterprise Access Management server address. |
| OneSignServerCertificate | String | certificate |
Upload the Imprivata appliance certificate to the MDM when deploying Imprivata MDA to a device. |
Required only when using a self-signed certificate. Depending on your MDM interface, may appear as OneSign server certificate. |
| ExternalDeviceSerial | String |
|
Depending on your MDM, represents the serial number of the device. |
Imprivata MDA requires access to the device ID to report on individual login and device activity. |
| ConfigFlags | String | forceTrustedEAMCertificate |
Imprivata MDA checks for Imprivata appliance server certificate validity and allows you to check whether Imprivata appliance certificate is configured correctly.
|
Supported by Imprivata MDA 7.15 and later. See Trusted Communication to the Imprivata Appliance
|
| MamRegistrationMdmId | String | <ID> | MAM registration MDM ID from the Mobile Access server. |
Required for registering the Imprivata MDA app to the MDA console. |
| MamRegistrationMamServerAddress | String | <MAM server address>, typically groundctl.com. | Mobile Access server address. |
Required for registering the Imprivata MDA app to the MDA console. |
| MamRegistrationDeviceId | String |
|
Device identifier for registration to the MDA console. |
Required for registering the Imprivata MDA app to the MDA console. |
| MamRegistrationSecret | String | <registration secret> | Registration secret for registration to the MDA console. | Required for registering the Imprivata MDA app to the MDA console. |
Optional AppConfig Keys
These keys enable specific features or integrations when configured.
| AppConfig Configuration Key | AppConfig Value Type |
AppConfig Value |
Description | Notes |
|---|---|---|---|---|
| DefaultAuthDomain | String | <yourDomain> |
Set the domain selected by default when the user authenticates to Imprivata MDA with their username and password. . |
Depending on your MDM interface, this AppConfig may appear as: The domain selected by default when authenticating on MDA with username and password. |
| AdminAccessCode | String | <The Admin passcode> | Sets the passcode for admin access. |
Depending on your MDM interface, this may appear as Admin Access Code. Requires a minimum of 8 characters. |
| LockMode | String | CountdownToLockMode | Enables the Countdown to lock mode. | |
| CountdownToLockMinutes | String | 240 | Sets the number of minutes to count down before locking the device. |
Default value is 240 minutes (4 hours). Minimum value is 20 minutes. |
| DeviceInfoPattern | String | <string with Variables> |
Sets a string pattern containing the supported variables to identify the device, that will be replaced with actual device-specific strings. |
Depending on your MDM interface, this may appear as Device Info Pattern. Variables - obtained from system settings:
The variables can be combined with a customized text string to identify the device. Example: This is $DeviceName, $AndroidShortVersion Results: This is Galaxy Note 5, A13 See Configure the Display of Device Information on Authentication Screens |
| MobilePolicyOverride | String |
For the supported values, see the table of supported mobile policy values available for override. |
Override a limited set of properties of the EAM mobile policy using AppConfig setting. | |
| LandscapeDevices | String | Comma-separated list of mobile device model numbers | Change the mobile device's orientation from portrait to landscape mode. |
Depending on your MDM interface, this may appear as Landscape devices. Device numbers can be found in Android settings, but may depend on the device vendor and Android version. Example: Versity 9540, SM-G95OU1, Pixel 4 |
Configuration Flags
These ConfigFlags enable specific behavior and functionality in the MDA mobile policies or for specific integrations.
| AppConfig Configuration Key | AppConfig Value Type |
AppConfig Value |
Description | Notes |
|---|---|---|---|---|
| ConfigFlags | String | allowOfflineMode | Enables offline mode, allowing authenticated users to Imprivata MDA to unlock the device and have SSO available when in offline mode. | |
| ConfigFlags | String | allowUntrustedEAMCertificate |
Enabled by default in Imprivata MDA 7.15 and later.
|
This communication method is considered as not secure, but is for backward compatibility or for administrators to use while they resolve Imprivata appliance certificate issues.
|
| ConfigFlags | String | lockOnLogoutFail | Locks the device if any app logout action fails. |
Supported by Imprivata MDA 10.0 and later For more information, see Lock on App Logout Failure |
| ConfigFlags | String | browserLogoutLast |
Sets the order of MDA logout operations to log the browser out last. This AppConfig allows backwards compatibility to support the order of logout operations used in earlier releases of MDA. |
Imprivata MDA 8.2 makes changes to the order of logout operations. For more information, see MDAOrder of Logout Operations. |
| ConfigFlags | String | bootLockDelay=60 |
When bootLockDelay is in effect, the device cannot be unlocked. The delay timer only starts when the device has finished rebooting.
|
Supported by Imprivata MDA 8.2 and later. |
| ConfigFlags | String | fidoEnrollmentOn |
Allows users to enroll their unenrolled FIDO2 security keys from the Imprivata MDA app. If treatNfcTapAsProx is set, Imprivata MDA will ignore fidoEnrollmentOn. |
Supported by Imprivata MDA 8.2 and later. |
| ConfigFlags | String | dexControlOn |
Use Samsung DeX functionality. The device prompts for the required Device Administrator permissions and activates required Knox SDK license. Enables the Samsung DeX session to stop when MDA is signed out. |
Supported by Imprivata MDA 8.1 and later. See Samsung DeX. |
| ConfigFlags | String | treatNfcTapAsProx |
For customers with proximity cards that communicate with the same protocol as FIDO2 security keys, treatNfcTapAsProx enables proximity card-only mode.
|
Supported by Imprivata MDA 8.1 and later.
|
| ConfigFlags | String |
emergencyCalls emergencyCalls:<phone number> emergencyCalls:<phone number>|skipConfirmation |
Allows the user access to the phone dial pad so they can make phone calls from the Imprivata MDA lock screen, without the user needing to authenticate to the device. To define a preconfigured phone number, set the <phone number> value to the phone number needed. Supports US and International phone number formats. skipConfirmation removes the confirmation dialog box that pops up before a call. |
Supported by Imprivata MDA 8.1 and later. See Emergency Calls |
| ConfigFlags | String | forbidForegroundServiceNotificationCanceling |
Sets the Imprivata MDA foreground service notification to be non-cancellable.
|
|
| ConfigFlags | String | verboseLogsOn | Collect Imprivata MDA verbose logs. | Overrides the Verbose Logging switch on Imprivata MDA Settings page. |
| ConfigFlags | String | logcatOn | Send Imprivata MDA logs to Logcat. |
Helpful for troubleshooting purposes. For security reasons, by default, Imprivata MDA only sends error logs to Logcat. |
| ConfigFlag | String | ignoreCustomContentView |
Beginning with 10.1, Imprivata MDA draws Conent view UI on MDA Lock screen notifications by default. In previous releases, Imprivata MDA didn't show notification contents from Custom Content view if a notification had one, resulting in an empty notification shown over the Imprivata MDA Lock screen. |
Supported in Imprivata MDA 10.1 and later.
|
| ConfigFlag | String | msalLoginDomain |
Sets the domain name to use when building UPN formatted usernames for MSAL login that is enabled by the msalLoginOn flag. This flag is useful when the EAM user identity is configured with a different domain name than the Microsoft Entra ID domain name. Without the msalLoginOn flag setting msalLoginDomain has no effect. |
Supported in Imprivata MDA 10.1 and later. |
| ConfigFlags | String | msalLoginShowUserConsent | When present, the MSAL consent screen is shown to the user; omitting this flag causes Imprivata MDA to bypass the consent screen automatically. | |
| ConfigFlags | String | msalLoginTimeout=<ms> |
Overrides the MSAL sign-in timeout. Default is 15000 ms. Example: msalLoginTimeout=30000. |
|
| ConfigFlags | String |
msalLoginOn |
Automatically sign the user in to Microsoft apps when using shared device mode. | |
| ConfigFlags | String | followMsalGlobalSignout | Automatically sign the user out of all apps, including non-MSAL apps, when the user logs out of a Microsoft app. | |
| ConfigFlags | String | autostartApps=[appPackagenames] | Automatically launch the apps on checkout. | |
| ConfigFlags | String | autostartDelayMillis=<milliseconds> |
Allows a delay, in milliseconds, before Imprivata MDA starts processing AutostartApps. |
|
| ConfigFlags | String | autostartPeriodMillis=<milliseconds> |
Allows a delay, in milliseconds, between AutostartApps launch attempts. |
|
| ConfigFlags | String | lockOnCharge |
Lock the device when Imprivata MDA detects the device is charging Used with logoutOnCharge |
|
| ConfigFlags | String | logoutOnCharge |
Log the user out from the apps when Imprivata MDA detects the device is charging. Used with lockOnCharge |
|
| ConfigFlags | String | offlineToOnlineReauth |
Require the user to reauthenticate when Imprivata MDA transitions from offline to online, only when the user session was last unlocked in offline. The flag has no effect on online established sessions. Used in combination with allowOfflineMode. |
|
| ConfigFlags | String | deviceSdkLogout |
Use the Zebra SDK for all SDK based logout methods. Setting deviceSdkLogout is equivalent to setting the following three values:
|
|
| ConfigFlags | String | deviceSdkClearData | Use the Zebra SDK for clearing data based on the SDK. | |
| ConfigFlags | String | deviceSdkClearData | Use the Zebra SDK for clearing cache based on the SDK | |
| ConfigFlags | String | deviceSdkForceStop | Use the Zebra SDK to force stop based on the SDK. | |
| ConfigFlags | String | numericPinOnly | Set the device's keypad to numeric only |
If numericPinOnly is not set, the default behavior of Imprivata MDA is to allow the keypad to be alphanumeric |
| ConfigFlags | String | preventAccidentalTyping |
Prevent users from accidentally typing characters into credentials screens. |
|
| ConfigFlags | String | autofillOn | Allow the Autofill Service to use Imprivata MDA. |
See Configuring Imprivata Mobile Device Access with the Google Autofill Framework. |
| ConfigFlags | String | com.package.name:forceStop| clearCache|clearData |
Run additional logout actions or different logout methods for the same app. | |
| ConfigFlags | String | allowScreensaver | Allows Imprivata MDA to coexist with device screensavers and not block their use. | |
| ConfigFlags | String | zams |
Allows Zebra Access Management System |
Works with ZAMS v.2.2.9 or later See Configure Imprivata MDA with Zebra Access Management System (ZAMS) |
Next Steps
Configure Imprivata MDA in your Imprivata enterprise.