Macros

Endpoint Management provides macros as a way to populate user or device property data within the text field of the following items:

  • Policies
  • Notifications
  • Enrollment templates
  • Device configuration XML file
  • Automated actions
  • Credential provider Certificate Signing Requests

Endpoint Management replaces a macro with the corresponding user or system values. For example, you can prepopulate the mailbox value for a user in a single Exchange profile across thousands of users.

Macro syntax

A macro can take the following form:

  • ${type.PROPERTYNAME}
  • ${type.PROPERTYNAME ['DEFAULT VALUE'] [ | FUNCTION [(ARGUMENT1, ARGUMENT2)]}

Enclose all syntax following the dollar sign ($) in curly brackets ({ }).

  • Qualified property names reference either a user property, a device property, or a custom property.
  • Qualified property names consist of a prefix, followed by the actual property name.
  • User properties take the form ${user.[PROPERTYNAME] (prefix="user.")}.
  • Device properties take the form ${device.[PROPERTYNAME] (prefix="device.")}.
  • Property names are case-sensitive.
  • A function can be a limited list or a link to a third-party reference that defines functions. This macro for a notification message includes the function firstnotnull:

Device ${firstnotnull(device.TEL_NUMBER,device.serialNumber)} has been blocked…

  • For custom macros (properties that you define), the prefix is ${custom}. You can omit the prefix.

Here’s an example of a commonly used macro, ${user.username}, that populates the user name value in the text field of a policy. This macro is useful for configuring Exchange ActiveSync profiles and other profiles used by multiple users. The following example shows how to use macros in an Exchange policy. The macro for User is ${user.username}. The macro for Email address is ${user.mail}.

Macro in Device Policy configuration screen

The following example shows how to use macros for a certificate signing request. The macro for Subject name is CN=$user.username. The macro for the Value of a Subject alternative name is $user.userprincipalname.

Macro in Credential Providers configuration screen

The following example shows how to use macros in a notification template. The example template defines the message sent to a user when HDX applications are blocked because of a non-compliant device. The macro for the Message is:

Device ${firstnotnull(device.TEL_NUMBER,device.serialNumber)} no longer complies with the device policy and HDX applications will be blocked.

Macro in Notification Templates configuration screen

For more examples of macros used in notifications, go to Settings > Notification Templates, select a pre-defined template, and click Edit.

The following example shows a macro in the Device Name device policy. You can type a macro, a combination of macros, or a combination of macros and text to name each device uniquely. For example, use ${device.serialnumber} to set the device names to the serial number of each device. Use ${device.serialnumber} ${ user.username } to include the user name in the device name. The Device Name device policy works on supervised iOS and macOS devices.

Macro in Device Policy configuration screen

Macros for default notification templates

You can use the following macros in the default notification templates:

  • ${account.SUPPORT_EMAIL}
  • ${applicationName}
  • ${enrollment.andriod.agent.download.url}
  • ${enrollment.ios.agent.download.url}
  • ${enrollment.pin}
  • ${enrollment.url}
  • ${enrollment.urls}
  • ${enrollment.ios.url}
  • ${enrollment.macos.url}
  • ${enrollment.android.url}
  • ${enrollment.ios.platform}
  • ${enrollment.macos.platform}
  • ${enrollment.android.platform}
  • ${firstnotnull(device.TEL_NUMBER,device.serialNumber)}
  • ${firstnotnull(device.TEL_NUMBER,user.mobile)}
  • ${outofcompliance.reason(smg_block)}
  • ${outofcompliance.reason(whitelist_blacklist_apps_name)}
  • ${vpp.account}
  • ${vpp.appname}
  • ${vpp.url}
  • ${zdmserver.hostPath}/enroll

This example shows how to create a notification that includes enrollment URLs for multiple device platforms. The macro for the Message is:

${enrollment.urls}

Notification Template settings screen

These examples show how to create messages for notifications that prompt the users to click the enrollment URL for their device platforms:

Example 1:

To enroll, click the link below that applies to your device platform:

${enrollment.ios.platform} - ${enrollment.ios.url}

${enrollment.macos.platform} - ${enrollment.macos.url}

${enrollment.android.platform} - ${enrollment.android.url}

Example 2:

To enroll an iOS device, click the link ${enrollment.ios.url}.

To enroll a macOS device, click the link ${enrollment.macos.url}.

To enroll an Android device, click the link ${enrollment.android.url}.

Macros for specific policies

For the Device Name device policy (for iOS and macOS), you can use these macros for the Device name:

  • ${device.serialnumber}
  • ${user.username}@example.com
  • ${device.serialnumber}
  • ${device.serialnumber}
  • ${user.username}
  • ${enrollment.pin}
  • ${user.dnsroot}

For the Cellular device policy (for iOS), you can use macros for the values of non-string fields, such as Proxy server port. For example, you can now use a macro such as ${device.xyz} or ${setting.xyz}, which expands into an integer.

For a device configuration XML file that you import into Endpoint Management by using the Import iOS & macOS Profile device policy, you can use macros for the values of non-string fields.

For the Samsung MDM License Key device policy, you can use this macro for the ELM license key:

  • ${elm.license.key}

For the Webclip device policy, you can use this macro for the URL:

  • ${webeas-url}

Macros to obtain built-in device properties

Display name: Device Id

  • Macros: $device.id

Display name: Device IMEI

  • Macros: $device.imei

Display name: OS Family

  • Macros: $device.OSFamily

Display name: Serial Number

  • Macros: $device.serialNumber

Macros for all device properties

Display name: Account Suspended?

  • Web element: GOOGLE_AW_DIRECTORY_SUSPENDED

  • Macros: ${device.GOOGLE_AW_DIRECTORY_SUSPENDED}

Display name: Activation lock bypass code

  • Web element: ACTIVATION_LOCK_BYPASS_CODE

  • Macros: ${device.ACTIVATION_LOCK_BYPASS_CODE}

Display name: Activation lock enabled

  • Web element: ACTIVATION_LOCK_ENABLED

  • Macros: ${device.ACTIVATION_LOCK_ENABLED}

Display name: Active iTunes account

  • Web element: ACTIVE_ITUNES

  • Macros: ${device.ACTIVE_ITUNES}

Display name: ActiveSync device known by MSP
  • Web element: AS_DEVICE_KNOWN_BY_ZMSP

  • Macros: ${device.AS_DEVICE_KNOWN_BY_ZMSP}

Display name: Administrator disabled

  • Web element: ADMIN_DISABLED

  • Macros: ${device.ADMIN_DISABLED}

Display name: AIK Present?

  • Web element: WINDOWS_HAS_AIK_PRESENT

  • Macros: ${device.WINDOWS_HAS_AIK_PRESENT}

Display name: Amazon MDM API available

  • Web element: AMAZON_MDM

  • Macros: ${device.AMAZON_MDM}

Display name: Android Enterprise Device ID

  • Web element: GOOGLE_AW_DEVICE_ID

  • Macros: ${device.GOOGLE_AW_DEVICE_ID}

Display name: Android Enterprise Enabled Device?

  • Web element: GOOGLE_AW_ENABLED_DEVICE

  • Macros: ${device.GOOGLE_AW_ENABLED_DEVICE}

Display name: Android Enterprise Install Type

  • Web element: GOOGLE_AW_INSTALL_TYPE

  • Macros: ${device.GOOGLE_AW_INSTALL_TYPE}

Display name: Antispyware Signature status

  • Web element: ANTI_SPYWARE_SIGNATURE_STATUS

  • Macros: ${device.ANTI_SPYWARE_SIGNATURE_STATUS}

Display name: Antispyware Status

  • Web element: ANTI_SPYWARE_STATUS

  • Macros: ${device.ANTI_SPYWARE_STATUS}

Display name: Antivirus Signature Status

  • Web element: ANTI_VIRUS_SIGNATURE_STATUS

  • Macros: ${device.ANTI_VIRUS_SIGNATURE_STATUS}

Display name: Antivirus Status

  • Web element: ANTI_VIRUS_STATUS

  • Macros: ${device.ANTI_VIRUS_STATUS}

Display name: ASM DEP activation lock bypass code

  • Web element: DEP_ACTIVATION_LOCK_BYPASS_CODE

  • Macros: ${device.DEP_ACTIVATION_LOCK_BYPASS_CODE}

Display name: ASM DEP escrow key

  • Web element: DEP_ESCROW_KEY

  • Macros: ${device.DEP_ESCROW_KEY}

Display name: Asset tag

  • Web element: ASSET_TAG

  • Macros: ${device.ASSET_TAG}

Display name: Automatically check software updates

  • Web element: AutoCheckEnabled

  • Macros: ${device.AutoCheckEnabled}

Display name: Automatically download software updates in the background

  • Web element: BackgroundDownloadEnabled

  • Macros: ${device.BackgroundDownloadEnabled}

Display name: Automatically install app updates

  • Web element: AutomaticAppInstallationEnabled

  • Macros: ${device.AutomaticAppInstallationEnabled}

Display name: Automatically install OS updates

  • Web element: AutomaticOSInstallationEnabled

  • Macros: ${device.AutomaticOSInstallationEnabled}

Display name: Automatically install security updates

  • Web element: AutomaticSecurityUpdatesEnabled

  • Macros: ${device.AutomaticSecurityUpdatesEnabled}

Display name: Autoupdate Status

  • Web element: AUTOUPDATE_STATUS

  • Macros: ${device.AUTOUPDATE_STATUS}

Display name: Available RAM

  • Web element: MEMORY_AVAILABLE

  • Macros: ${device.MEMORY_AVAILABLE}

Display name: Available software updates

  • Web element: AVAILABLE_OS_UPDATE_HUMAN_READABLE

  • Macros: ${device.AVAILABLE_OS_UPDATE_HUMAN_READABLE}

Display name: Available storage space

  • Web element: FREEDISK

  • Macros: ${device.FREEDISK}

Display name: Backup battery

  • Web element: BACKUP_BATTERY_PERCENT

  • Macros: ${device.BACKUP_BATTERY_PERCENT}

Display name: Baseband firmware version

  • Web element: MODEM_FIRMWARE_VERSION

  • Macros: `${device.MODEM_FIRMWARE_VERSION}

Display name: Battery Charging

  • Web element: BATTERY_CHARGING_STATUS

  • Macros: ${device.BATTERY_CHARGING_STATUS}

Display name: Battery charging

  • Web element: BATTERY_CHARGING

  • Macros: ${device.BATTERY_CHARGING}

Display name: Battery Remaining

  • Web element: BATTERY_ESTIMATED_CHARGE_REMAINING

  • Macros: ${device.BATTERY_ESTIMATED_CHARGE_REMAINING}

Display name: Battery Runtime

  • Web element: BATTERY_RUNTIME

  • Macros: ${device.BATTERY_RUNTIME}

Display name: Battery Status

  • Web element: BATTERY_STATUS

  • Macros: ${device.BATTERY_STATUS}

Display name: BES device known by MSP

  • Web element: BES_DEVICE_KNOWN_BY_ZMSP

  • Macros: ${device.BES_DEVICE_KNOWN_BY_ZMSP}

Display name: BES PIN

  • Web element: BES_PIN

  • Macros: ${device.BES_PIN}

Display name: BES server agent ID

  • Web element: AGENT_ID

  • Macros: ${device.AGENT_ID}

Display name: BES server name

  • Web element: BES_SERVER

  • Macros: ${device.BES_SERVER}

Display name: BES server version

  • Web element: BES_VERSION

  • Macros: ${device.BES_VERSION}

Display name: BIOS Info

  • Web element: BIOS_INFO

  • Macros: ${device.BIOS_INFO}

Display name: BitLocker Status

  • Web element: WINDOWS_HAS_BIT_LOCKER_STATUS

  • Macros: ${device.WINDOWS_HAS_BIT_LOCKER_STATUS}

Display name: Bluetooth MAC address

  • Web element: BLUETOOTH_MAC

  • Macros: ${device.BLUETOOTH_MAC}

Display name: Boot Debugging Enabled?

  • Web element: WINDOWS_HAS_BOOT_DEBUGGING_ENABLED

  • Macros: ${device.WINDOWS_HAS_BOOT_DEBUGGING_ENABLED}

Display name: Boot Manager Rev List Version

  • Web element: WINDOWS_HAS_BOOT_MGR_REV_LIST_VERSION

  • Macros: ${device.WINDOWS_HAS_BOOT_MGR_REV_LIST_VERSION}

Display name: Carrier Code

  • Web element: CARRIER_CODE

  • Macros: ${device.CARRIER_CODE}

Display name: Carrier settings version

  • Web element: CARRIER_SETTINGS_VERSION

  • Macros: ${device.CARRIER_SETTINGS_VERSION}

Display name: Catalog URL

  • Web element: CatalogURL

  • Macros: ${device.CatalogURL}

Display name: Cellular altitude

  • Web element: GPS_ALTITUDE_FROM_CELLULAR

  • Macros: ${device.GPS_ALTITUDE_FROM_CELLULAR}

Display name: Cellular course

  • Web element: GPS_COURSE_FROM_CELLULAR

  • Macros: ${device.GPS_COURSE_FROM_CELLULAR}

Display name: Cellular horizontal accuracy

  • Web element: GPS_HORIZONTAL_ACCURACY_FROM_CELLULAR

  • Macros: ${device.GPS_HORIZONTAL_ACCURACY_FROM_CELLULAR}

Display name: Cellular latitude

  • Web element: GPS_LATITUDE_FROM_CELLULAR

  • Macros: ${device.GPS_LATITUDE_FROM_CELLULAR}

Display name: Cellular longitude

  • Web element: GPS_LONGITUDE_FROM_CELLULAR

  • Macros: ${device.GPS_LONGITUDE_FROM_CELLULAR}

Display name: Cellular speed

  • Web element: GPS_SPEED_FROM_CELLULAR

  • Macros: ${device.GPS_SPEED_FROM_CELLULAR}

Display name: Cellular technology

  • Web element: CELLULAR_TECHNOLOGY

  • Macros: ${device.CELLULAR_TECHNOLOGY}

Display name: Cellular timestamp

  • Web element: GPS_TIMESTAMP_FROM_CELLULAR

  • Macros: ${device.GPS_TIMESTAMP_FROM_CELLULAR}

Display name: Cellular vertical accuracy

  • Web element: GPS_VERTICAL_ACCURACY_FROM_CELLULAR

  • Macros: ${device.GPS_VERTICAL_ACCURACY_FROM_CELLULAR}

Display name: Change Password at Next Login?

  • Web element: GOOGLE_AW_DIRECTORY_CHANGE_PASSWORD_NEXT_LOGIN

  • Macros: `${device.GOOGLE_AW_DIRECTORY_CHANGE_PASSWORD_NEXT_LOGIN}

Display name: Client device ID

  • Web element: CLIENT_DEVICE_ID

  • Macros: ${device.CLIENT_DEVICE_ID}

Display name: Cloud backup enabled

  • Web element: CLOUD_BACKUP_ENABLED

  • Macros: ${device.CLOUD_BACKUP_ENABLED}

Display name: Code Integrity Enabled?

  • Web element: WINDOWS_HAS_CODE_INTEGRITY_ENABLED

  • Macros: ${device.WINDOWS_HAS_CODE_INTEGRITY_ENABLED}

Display name: Code Integrity Rev List Version

  • Web element: WINDOWS_HAS_CODE_INTGTY_REV_LIST_VERSION

  • Macros: ${device.WINDOWS_HAS_CODE_INTGTY_REV_LIST_VERSION}

Display name: Color

  • Web element: COLOR

  • Macros: ${device.COLOR}

Display name: CPU clock speed

  • Web element: CPU_CLOCK_SPEED

  • Macros: ${device.CPU_CLOCK_SPEED}

Display name: CPU type

  • Web element: CPU_TYPE

  • Macros: ${device.CPU_TYPE}

Display name: Creation Time

  • Web element: GOOGLE_AW_DIRECTORY_CREATION_TIME

  • Macros: ${device.GOOGLE_AW_DIRECTORY_CREATION_TIME}

Display name: Critical software updates

  • Web element: AVAILABLE_OS_UPDATE_IS_CRITICAL

  • Macros: ${device.AVAILABLE_OS_UPDATE_IS_CRITICAL}

Display name: Current carrier network

  • Web element: CARRIER

  • Macros: ${device.CARRIER}

Display name: Current mobile country code

  • Web element: CURRENT_MCC

  • Macros: ${device.CURRENT_MCC}

Display name: Current mobile network code

  • Web element: CURRENT_MNC

  • Macros: ${device.CURRENT_MNC}

Display name: Data roaming allowed

  • Web element: DATA_ROAMING_ENABLED

  • Macros: ${device.DATA_ROAMING_ENABLED}

Display name: Date of the last iCloud backup

  • Web element: LAST_CLOUD_BACKUP_DATE

  • Macros: ${device.LAST_CLOUD_BACKUP_DATE}

Display name: Default catalog

  • Web element: IsDefaultCatalog

  • Macros: ${device.IsDefaultCatalog}

Display name: DEP account name

  • Web element: BULK_ENROLLMENT_DEP_ACCOUNT_NAME

  • Macros: ${device.BULK_ENROLLMENT_DEP_ACCOUNT_NAME}

Display name: DEP Policy

  • Web element: WINDOWS_HAS_DEP_POLICY

  • Macros: ${device.WINDOWS_HAS_DEP_POLICY}

Display name: DEP profile assigned

  • Web element: PROFILE_ASSIGN_TIME

  • Macros: ${device.PROFILE_ASSIGN_TIME}

Display name: DEP profile pushed

  • Web element: PROFILE_PUSH_TIME

  • Macros: ${device.PROFILE_PUSH_TIME}

Display name: DEP profile removed

  • Web element: PROFILE_REMOVE_TIME

  • Macros: ${device.PROFILE_REMOVE_TIME}

Display name: DEP registration by

  • Web element: DEVICE_ASSIGNED_BY

  • Macros: ${device.DEVICE_ASSIGNED_BY}

Display name: DEP registration date

  • Web element: DEVICE_ASSIGNED_DATE

  • Macros: ${device.DEVICE_ASSIGNED_DATE}

Display name: Description

  • Web element: DESCRIPTION

  • Macros: ${device.DESCRIPTION}

Display name: Device model

  • Web element: SYSTEM_OEM

  • Macros: ${device.SYSTEM_OEM}

Display name: Device name

  • Web element: DEVICE_NAME

  • Macros: ${device.DEVICE_NAME}

Display name: Device Type

  • Web element: DEVICE_TYPE

  • Macros: ${device.DEVICE_TYPE}

Display name: Do Not Disturb activated

  • Web element: DO_NOT_DISTURB

  • Macros: ${device.DO_NOT_DISTURB}

Display name: ELAM Driver Loaded?

  • Web element: WINDOWS_HAS_ELAM_DRIVER_LOADED

  • Macros: ${device.WINDOWS_HAS_ELAM_DRIVER_LOADED}

Display name: Encryption Compliance

  • Web element: ENCRYPTION_COMPLIANCE

  • Macros: ${device.ENCRYPTION_COMPLIANCE}

Display name: ENROLLMENT_KEY_GENERATION_DATE

  • Web element: ENROLLMENT_KEY_GENERATION_DATE

  • Macros: ${device.ENROLLMENT_KEY_GENERATION_DATE}

Display name: Enterprise ID

  • Web element: ENTERPRISEID

  • Macros: ${device.ENTERPRISEID}

Display name: External storage 1: available space

  • Web element: EXTERNAL_STORAGE1_FREE_SPACE

  • Macros: ${device.EXTERNAL_STORAGE1_FREE_SPACE}

Display name: External storage 1: available space

  • Web element: EXTERNAL_STORAGE1_FREE_SPACE

  • Macros: ${device.EXTERNAL_STORAGE1_FREE_SPACE}

Display name: External storage 1: name

  • Web element: EXTERNAL_STORAGE1_NAME

  • Macros: ${device.EXTERNAL_STORAGE1_NAME}

Display name: External storage 1: total space

  • Web element: EXTERNAL_STORAGE1_TOTAL_SPACE

  • Macros: ${device.EXTERNAL_STORAGE1_TOTAL_SPACE}

Display name: External storage 2: available space

  • Web element: EXTERNAL_STORAGE2_FREE_SPACE

  • Macros: ${device.EXTERNAL_STORAGE2_FREE_SPACE}

Display name: External storage 2: name

  • Web element: EXTERNAL_STORAGE2_NAME

  • Macros: ${device.EXTERNAL_STORAGE2_NAME}

Display name: External storage 2: total space

  • Web element: EXTERNAL_STORAGE2_TOTAL_SPACE

  • Macros: ${device.EXTERNAL_STORAGE2_TOTAL_SPACE}

Display name: External storage encrypted

  • Web element: EXTERNAL_ENCRYPTION

  • Macros: ${device.EXTERNAL_ENCRYPTION}

Display name: FileVault Enabled

  • Web element: IS_FILEVAULT_ENABLED

  • Macros: ${device.IS_FILEVAULT_ENABLED}

Display name: Firewall Status

  • Web element: DEVICE_FIREWALL_STATUS

  • Macros: ${device.DEVICE_FIREWALL_STATUS}

Display name: Firewall Status

  • Web element: DEVICE_FIREWALL_STATUS

  • Macros: ${device.DEVICE_FIREWALL_STATUS}

Display name: Firewall Status

  • Web element: FIREWALL_STATUS

  • Macros: ${device.FIREWALL_STATUS}

Display name: Firmware version

  • Web element: FIRMWARE_VERSION

  • Macros: ${device.FIRMWARE_VERSION}

Display name: First synchronization

  • Web element: ZMSP_FIRST_SYNC

  • Macros: ${device.ZMSP_FIRST_SYNC}

Display name: Google Directory Alias

  • Web element: GOOGLE_AW_DIRECTORY_GOOGLE_ALIAS

  • Macros: ${device.GOOGLE_AW_DIRECTORY_GOOGLE_ALIAS}

Display name: Google Directory Family Name

  • Web element: GOOGLE_AW_DIRECTORY_FAMILY_NAME

  • Macros: ${device.GOOGLE_AW_DIRECTORY_FAMILY_NAME}

Display name: Google Directory Name

  • Web element: GOOGLE_AW_DIRECTORY_NAME

  • Macros: ${device.GOOGLE_AW_DIRECTORY_NAME}

Display name: Google Directory Primary Email

  • Web element: GOOGLE_AW_DIRECTORY_PRIMARY

  • Macros: ${device.GOOGLE_AW_DIRECTORY_PRIMARY}

Display name: Google Directory User ID

  • Web element: GOOGLE_AW_DIRECTORY_USER_ID

  • Macros: ${device.GOOGLE_AW_DIRECTORY_USER_ID}

Display name: GPS altitude

  • Web element: GPS_ALTITUDE_FROM_GPS

  • Macros: ${device.GPS_ALTITUDE_FROM_GPS}

Display name: GPS course

  • Web element: GPS_COURSE_FROM_GPS

  • Macros: ${device.GPS_COURSE_FROM_GPS}

Display name: GPS horizontal accuracy

  • Web element: GPS_HORIZONTAL_ACCURACY_FROM_GPS

  • Macros: ${device.GPS_HORIZONTAL_ACCURACY_FROM_GPS}

Display name: GPS latitude

  • Web element: GPS_LATITUDE_FROM_GPS

  • Macros: ${device.GPS_LATITUDE_FROM_GPS}

Display name: GPS longitude

  • Web element: GPS_LONGITUDE_FROM_GPS

  • Macros: ${device.GPS_LONGITUDE_FROM_GPS}

Display name: GPS speed

  • Web element: GPS_SPEED_FROM_GPS

  • Macros: ${device.GPS_SPEED_FROM_GPS}

Display name: GPS timestamp

  • Web element: GPS_TIMESTAMP_FROM_GPS

  • Macros: ${device.GPS_TIMESTAMP_FROM_GPS}

Display name: GPS vertical accuracy

  • Web element: GPS_VERTICAL_ACCURACY_FROM_GPS

  • Macros: ${device.GPS_VERTICAL_ACCURACY_FROM_GPS}

Display name: Hardware Device ID

  • Web element: HW_DEVICE_ID

  • Macros: ${device.HW_DEVICE_ID}

Display name: Hardware encryption capabilities

  • Web element: HARDWARE_ENCRYPTION_CAPS

  • Macros: ${device.HARDWARE_ENCRYPTION_CAPS}

Display name: HAS_CONTAINER

  • Web element: HAS_CONTAINER

  • Macros: ${device.HAS_CONTAINER}

Display name: Hash of the iTunes store account currently logged on

  • Web element: ITUNES_STORE_ACCOUNT_HASH

  • Macros: ${device.ITUNES_STORE_ACCOUNT_HASH}

Display name: Home carrier network

  • Web element: SIM_CARRIER_NETWORK

  • Macros: ${device.SIM_CARRIER_NETWORK}

Display name: Home mobile country code

  • Web element: SIM_MCC

  • Macros: ${device.SIM_MCC}

Display name: Home mobile network code

  • Web element: SIM_MNC

  • Macros: ${device.SIM_MNC}

Display name: HTC API version

  • Web element: HTC_MDM_VERSION

  • Macros: ${device.HTC_MDM_VERSION}

Display name: HTC MDM API available

  • Web element: HTC_MDM

  • Macros: ${device.HTC_MDM}

Display name: ICCID

  • Web element: ICCID

  • Macros: ${device.ICCID}

Display name: Identity

  • Web element: AS_DEVICE_IDENTITY

  • Macros: ${device.AS_DEVICE_IDENTITY}

Display name: IMEI/MEID number

  • Web element: IMEI

  • Macros: ${device.IMEI}

Display name: IMSI

  • Web element: SIM_ID

  • Macros: ${device.SIM_ID}

Display name: Internal storage encrypted

  • Web element: LOCAL_ENCRYPTION

  • Macros: ${device.LOCAL_ENCRYPTION}

Display name: IP location

  • Web element: IP_LOCATION

  • Macros: ${device.IP_LOCATION}

Display name: IPV4 Address

  • Web element: IP_ADDRESSV4

  • Macros: ${device.IP_ADDRESSV4}

Display name: IPV6 Address

  • Web element: IP_ADDRESSV6

  • Macros: ${device.IP_ADDRESSV6}

Display name: Issued At

  • Web element: WINDOWS_HAS_ISSUED_AT

  • Macros: ${device.WINDOWS_HAS_ISSUED_AT}

Display name: Jailbroken/Rooted

  • Web element: ROOT_ACCESS

  • Macros: ${device.ROOT_ACCESS}

Display name: Kernel Debugging Enabled?

  • Web element: WINDOWS_HAS_OS_KERNEL_DEBUGGING_ENABLED

  • Macros: ${device.WINDOWS_HAS_OS_KERNEL_DEBUGGING_ENABLED}

Display name: Kiosk mode

  • Web element: IS_KIOSK

  • Macros: ${device.IS_KIOSK}

Display name: Last known IP address

  • Web element: LAST_IP_ADDR

  • Macros: ${device.LAST_IP_ADDR}

Display name: Last policy update time

  • Web element: LAST_POLICY_UPDATE_TIME

  • Macros: ${device.LAST_POLICY_UPDATE_TIME}

Display name: Last scan date

  • Web element: PreviousScanDate

  • Macros: ${device.PreviousScanDate}

Display name: Last scan result

  • Web element: PreviousScanResult

  • Macros: ${device.PreviousScanResult}

Display name: Last scheduled software updates

  • Web element: AVAILABLE_OS_UPDATE_INSTALL_LAST_ATTEMPT_TIME

  • Macros: ${device.AVAILABLE_OS_UPDATE_INSTALL_LAST_ATTEMPT_TIME}

Display name: Last scheduled software updates failure message

  • Web element: AVAILABLE_OS_UPDATE_INSTALL_FAIL_MSG

  • Macros: ${device.AVAILABLE_OS_UPDATE_INSTALL_FAIL_MSG}

Display name: Last scheduled software updates status

  • Web element: AVAILABLE_OS_UPDATE_INSTALL_STATUS

  • Macros: ${device.AVAILABLE_OS_UPDATE_INSTALL_STATUS}

Display name: Last synchronization

  • Web element: ZMSP_LAST_SYNC

  • Macros: ${device.ZMSP_LAST_SYNC}

Display name: Locator service enabled

  • Web element: DEVICE_LOCATOR

  • Macros: ${device.DEVICE_LOCATOR}

Display name: MAC Address

  • Web element: MAC_ADDRESS

  • Macros: ${device.MAC_ADDRESS}

Display name: MAC Address Network Connection

  • Web element: MAC_NETWORK_CONNECTION

  • Macros: ${device.MAC_NETWORK_CONNECTION}

Display name: MAC Address Type

  • Web element: MAC_ADDRESS_TYPE

  • Macros: ${device.MAC_ADDRESS_TYPE}

Display name: Mailbox Setup

  • Web element: GOOGLE_AW_DIRECTORY_MAILBOX_SETUP

  • Macros: ${device.GOOGLE_AW_DIRECTORY_MAILBOX_SETUP}

Display name: Main battery

  • Web element: MAIN_BATTERY_PERCENT

  • Macros: ${device.MAIN_BATTERY_PERCENT}

Display name: MDM lost mode enabled

  • Web element: IS_MDM_LOST_MODE_ENABLED

  • Macros: ${device.IS_MDM_LOST_MODE_ENABLED}

Display name: MDX_SHARED_ENCRYPTION_KEY

  • Web element: MDX_SHARED_ENCRYPTION_KEY

  • Macros: ${device.MDX_SHARED_ENCRYPTION_KEY}

Display name: MEID

  • Web element: MEID

  • Macros: ${device.MEID}

Display name: Mobile phone number

  • Web element: TEL_NUMBER

  • Macros: ${device.TEL_NUMBER}

Display name: Model ID

  • Web element: MODEL_ID

  • Macros: ${device.MODEL_ID}

Display name: Model Number

  • Web element: MODEL_NUMBER

  • Macros: ${device.MODEL_NUMBER}

Display name: Network Adapter Type

  • Web element: NETWORK_ADAPTER_TYPE

  • Macros: ${device.NETWORK_ADAPTER_TYPE}

Display name: Operating system build

  • Web element: SYSTEM_OS_BUILD

  • Macros: ${device.SYSTEM_OS_BUILD}

Display name: Operating System Edition

  • Web element: OS_EDITION

  • Macros: ${device.OS_EDITION}

Display name: Operating system language (locale)

  • Web element: SYSTEM_LANGUAGE

  • Macros: ${device.SYSTEM_LANGUAGE}

Display name: Operating system version

  • Web element: SYSTEM_OS_VERSION

  • Macros: ${device.SYSTEM_OS_VERSION}

Display name: Organization address

  • Web element: ORGANIZATION_ADDRESS

  • Macros: ${device.ORGANIZATION_ADDRESS}

Display name: Organization email

  • Web element: ORGANIZATION_EMAIL

  • Macros: ${device.ORGANIZATION_EMAIL}

Display name: Organization magic

  • Web element: ORGANIZATION_MAGIC

  • Macros: ${device.ORGANIZATION_MAGIC}

Display name: Organization name

  • Web element: ORGANIZATION_NAME

  • Macros: ${device.ORGANIZATION_NAME}

Display name: Organization phone number

  • Web element: ORGANIZATION_PHONE

  • Macros: ${device.ORGANIZATION_PHONE}

Display name: Out of Compliance

  • Web element: OUT_OF_COMPLIANCE

  • Macros: ${device.OUT_OF_COMPLIANCE}

Display name: Owned by

  • Web element: CORPORATE_OWNED

  • Macros: ${device.CORPORATE_OWNED}

Display name: Passcode compliant

  • Web element: PASSCODE_IS_COMPLIANT

  • Macros: ${device.PASSCODE_IS_COMPLIANT}

Display name: Passcode compliant with configuration

  • Web element: PASSCODE_IS_COMPLIANT_WITH_CFG

  • Macros: ${device.PASSCODE_IS_COMPLIANT_WITH_CFG}

Display name: Passcode present

  • Web element: PASSCODE_PRESENT

  • Macros: ${device.PASSCODE_PRESENT}

Display name: PCR0

  • Web element: WINDOWS_HAS_PCR0

  • Macros: ${device.WINDOWS_HAS_PCR0}

Display name: Perimeter breach

  • Web element: GPS_PERIMETER_BREACH

  • Macros: ${device.GPS_PERIMETER_BREACH}

Display name: Periodic check

  • Web element: PerformPeriodicCheck

  • Macros: ${device.PerformPeriodicCheck}

Display name: Personal Hotspot activated

  • Web element: PERSONAL_HOTSPOT_ENABLED

  • Macros: ${device.PERSONAL_HOTSPOT_ENABLED}

Display name: PIN code for geofence

  • Web element: PIN_CODE_FOR_GEO_FENCE

  • Macros: ${device.PIN_CODE_FOR_GEO_FENCE}

Display name: Platform

  • Web element: SYSTEM_PLATFORM

  • Macros: ${device.SYSTEM_PLATFORM}

Display name: Platform API level

  • Web element: API_LEVEL

  • Macros: ${device.API_LEVEL}

Display name: Policy name

  • Web element: POLICY_NAME

  • Macros: ${device.POLICY_NAME}

Display name: Primary Phone Number

  • Web element: IDENTITY1_PHONENUMBER

  • Macros: ${device.IDENTITY1_PHONENUMBER}

Display name: Primary SIM Carrier Operator

  • Web element: IDENTITY1_CARRIER_NETWORK_OPERATOR

  • Macros: ${device.IDENTITY1_CARRIER_NETWORK_OPERATOR}

Display name: Primary SIM ICCID

  • Web element: IDENTITY1_ICCID

  • Macros: ${device.IDENTITY1_ICCID}

Display name: Primary SIM IMEI

  • Web element: IDENTITY1_IMEI

  • Macros: ${device.IDENTITY1_IMEI}

Display name: Primary SIM IMSI

  • Web element: IDENTITY1_IMSI

  • Macros: ${device.IDENTITY1_IMSI}

Display name: Primary SIM Roaming

  • Web element: IDENTITY1_ROAMING

  • Macros: ${device.IDENTITY1_ROAMING}

Display name: Primary SIM Roaming

  • Web element: IDENTITY1_ROAMING_COMPLIANCE

  • Macros: ${device.IDENTITY1_ROAMING_COMPLIANCE}

Display name: Product name

  • Web element: PRODUCT_NAME

  • Macros: ${device.PRODUCT_NAME}

Display name: Publisher Device ID

  • Web element: PUBLISHER_DEVICE_ID

  • Macros: ${device.PUBLISHER_DEVICE_ID}

Display name: Reset Count

  • Web element: WINDOWS_HAS_RESET_COUNT

  • Macros: ${device.WINDOWS_HAS_RESET_COUNT}

Display name: Restart Count

  • Web element: WINDOWS_HAS_RESTART_COUNT

  • Macros: ${device.WINDOWS_HAS_RESTART_COUNT}

Display name: Safe Mode Enabled?

  • Web element: WINDOWS_HAS_SAFE_MODE

  • Macros: ${device.WINDOWS_HAS_SAFE_MODE}

Display name: Samsung Knox API available

  • Web element: SAMSUNG_KNOX

  • Macros: ${device.SAMSUNG_KNOX}

Display name: Samsung Knox API version

  • Web element: SAMSUNG_KNOX_VERSION

  • Macros: ${device.SAMSUNG_KNOX_VERSION}

Display name: Samsung Knox attestation

  • Web element: SAMSUNG_KNOX_ATTESTED

  • Macros: ${device.SAMSUNG_KNOX_ATTESTED}

Display name: Samsung Knox attestation updated date

  • Web element: SAMSUNG_KNOX_ATT_UPDATED_TIME

  • Macros: ${device.SAMSUNG_KNOX_ATT_UPDATED_TIME}

Display name: Samsung SAFE API available

  • Web element: SAMSUNG_MDM

  • Macros: ${device.SAMSUNG_MDM}

Display name: Samsung SAFE API version

  • Web element: SAMSUNG_MDM_VERSION

  • Macros: ${device.SAMSUNG_MDM_VERSION}

Display name: SBCP Hash

  • Web element: WINDOWS_HAS_SBCP_HASH

  • Macros: ${device.WINDOWS_HAS_SBCP_HASH}

Display name: Screen: height

  • Web element: SCREEN_HEIGHT

  • Macros: ${device.SCREEN_HEIGHT}

Display name: Screen: number of colors

  • Web element: SCREEN_NB_COLORS

  • Macros: ${device.SCREEN_NB_COLORS}

Display name: Screen: size

  • Web element: SCREEN_SIZE

  • Macros: ${device.SCREEN_SIZE}

Display name: Screen: width

  • Web element: SCREEN_WIDTH

  • Macros: ${device.SCREEN_WIDTH}

Display name: Screen: X-axis resolution

  • Web element: SCREEN_XDPI

  • Macros: ${device.SCREEN_XDPI}

Display name: Screen: Y-axis resolution

  • Web element: SCREEN_YDPI

  • Macros: ${device.SCREEN_YDPI}

Display name: Secondary Phone Number

  • Web element: IDENTITY2_PHONENUMBER

  • Macros: ${device.IDENTITY2_PHONENUMBER}

Display name: Secondary SIM Carrier Operator

  • Web element: IDENTITY2_CARRIER_NETWORK_OPERATOR

  • Macros: ${device.IDENTITY2_CARRIER_NETWORK_OPERATOR}

Display name: Secondary SIM ICCID

  • Web element: IDENTITY2_ICCID

  • Macros: ${device.IDENTITY2_ICCID}

Display name: Secondary SIM IMEI

  • Web element: IDENTITY2_IMEI

  • Macros: ${device.IDENTITY2_IMEI}

Display name: Secondary SIM IMSI

  • Web element: IDENTITY2_IMSI

  • Macros: ${device.IDENTITY2_IMSI}

Display name: Secondary SIM Roaming

  • Web element: IDENTITY2_ROAMING

  • Macros: ${device.IDENTITY2_ROAMING}

Display name: Secondary SIM Roaming Compliance

  • Web element: IDENTITY2_ROAMING_COMPLIANCE

  • Macros: ${device.IDENTITY2_ROAMING_COMPLIANCE}

Display name: Secure Boot Enabled?

  • Web element: WINDOWS_HAS_SECURE_BOOT_ENABLED

  • Macros: ${device.WINDOWS_HAS_SECURE_BOOT_ENABLED}

Display name: Secure Boot Status

  • Web element: SECURE_BOOT_STATE

  • Macros: ${device.SECURE_BOOT_STATE}

Display name: SecureContainer Enabled

  • Web element: DLP_ACTIVE

  • Macros: ${device.DLP_ACTIVE}

Display name: Security patch level

  • Web element: SYSTEM_SECURITY_PATCH_LEVEL

  • Macros: ${device.SYSTEM_SECURITY_PATCH_LEVEL}

Display name: Serial number

  • Web element: SERIAL_NUMBER

  • Macros: ${device.SERIAL_NUMBER}

Display name: SMS capable

  • Web element: IS_SMS_CAPABLE

  • Macros: ${device.IS_SMS_CAPABLE}

Display name: Sony Enterprise API available

  • Web element: SONY_MDM

  • Macros: ${device.SONY_MDM}`

Display name: Sony Enterprise API version

  • Web element: SONY_MDM_VERSION

  • Macros: ${device.SONY_MDM_VERSION}

Display name: Supervised

  • Web element: SUPERVISED

  • Macros: ${device.SUPERVISED}

Display name: Suspension Reason

  • Web element: GOOGLE_AW_DIRECTORY_SUSPENTION_REASON

  • Macros: ${device.GOOGLE_AW_DIRECTORY_SUSPENTION_REASON}

Display name: Tampered Status

  • Web element: TAMPERED_STATUS

  • Macros: ${device.TAMPERED_STATUS}

Display name: Terms & Conditions

  • Web element: TERMS_AND_CONDITIONS

  • Macros: ${device.TERMS_AND_CONDITIONS}

Display name: Terms And Agreement Accepted?

  • Web element: GOOGLE_AW_DIRECTORY_AGREED_TO_TERMS

  • Macros: ${device.GOOGLE_AW_DIRECTORY_AGREED_TO_TERMS}

Display name: Test Signing Enabled?

  • Web element: WINDOWS_HAS_TEST_SIGNING_ENABLED

  • Macros: ${device.WINDOWS_HAS_TEST_SIGNING_ENABLED}

Display name: Total RAM

  • Web element: MEMORY

  • Macros: ${device.MEMORY}

Display name: Total storage space

  • Web element: TOTAL_DISK_SPACE

  • Macros: ${device.TOTAL_DISK_SPACE}

Display name: TPM version

  • Web element: TPM_VERSION

  • Macros: ${device.TPM_VERSION}

Display name: UDID

  • Web element: UDID

  • Macros: ${device.UDID}

Display name: User Account Control Status

  • Web element: UAC_STATUS

  • Macros: ${device.UAC_STATUS}

Display name: User agent

  • Web element: USER_AGENT

  • Macros: ${device.USER_AGENT}

Display name: User defined #1

  • Web element: USER_DEFINED_1

  • Macros: ${device.USER_DEFINED_1}

Display name: User defined #2

  • Web element: USER_DEFINED_2

  • Macros: ${device.USER_DEFINED_2}

Display name: User defined #3

  • Web element: USER_DEFINED_3

  • Macros: ${device.USER_DEFINED_3}

Display name: User language (locale)

  • Web element: USER_LANGUAGE

  • Macros: ${device.USER_LANGUAGE}

Display name: Vendor

  • Web element: VENDOR

  • Macros: ${device.VENDOR}

Display name: Voice capable

  • Web element: IS_VOICE_CAPABLE

  • Macros: ${device.IS_VOICE_CAPABLE}

Display name: Voice roaming allowed

  • Web element: VOICE_ROAMING_ENABLED

  • Macros: ${device.VOICE_ROAMING_ENABLED}

Display name: VSM Enabled?

  • Web element: WINDOWS_HAS_VSM_ENABLED

  • Macros: ${device.WINDOWS_HAS_VSM_ENABLED}

Display name: Wi-Fi MAC address

  • Web element: WIFI_MAC

  • Macros: ${device.WIFI_MAC}

Display name: WINDOWS_ENROLLMENT_KEY

  • Web element: WINDOWS_ENROLLMENT_KEY

  • Macros: ${device.WINDOWS_ENROLLMENT_KEY}

Display name: WinPE Enabled?

  • Web element: WINDOWS_HAS_WINPE

  • Macros: ${device.WINDOWS_HAS_WINPE}

Display name: WNS Notification Status

  • Web element: PROPERTY_WNS_PUSH_STATUS

  • Macros: ${device.PROPERTY_WNS_PUSH_STATUS}

Display name: WNS Notification URL

  • Web element: PROPERTY_WNS_PUSH_URL

  • Macros: ${device.PROPERTY_WNS_PUSH_URL}

Display name: WNS Notification URL expiry date

  • Web element: PROPERTY_WNS_PUSH_URL_EXPIRY

  • Macros: ${device.PROPERTY_WNS_PUSH_URL_EXPIRY}

Display name: Endpoint Management agent ID

  • Web element: ENROLLMENT_AGENT_ID

  • Macros: {device.ENROLLMENT_AGENT_ID}`

Display name: Endpoint Management agent revision

  • Web element: EW_REVISION

  • Macros: ${device.EW_REVISION}

Display name: Endpoint Management agent version

  • Web element: EW_VERSION

  • Macros: ${device.EW_VERSION}

Display name: Zebra API available

  • Web element: ZEBRA_MDM

  • Macros: ${device.ZEBRA_MDM}

Display name: Zebra MXMF version

  • Web element: ZEBRA_MDM_VERSION

  • Macros: ${device.ZEBRA_MDM_VERSION}

Display name: Zebra Patch version

  • Web element: ZEBRA_PATCH_VERSION

  • Macros: ${device.ZEBRA_PATCH_VERSION}

Macros to obtain built-in user properties

Display name Macros
domainname (domain name; default domain) ${user.domainname}
loginname (user name plus domain name) ${user.loginname}
username (login name minus the domain, if any) ${user.username}

Macros for all user properties

Display name Web element Macros
Active Directory failed logon tries badpwdcount ${user.badpwdcount}
ActiveSync user email asuseremail ${user.asuseremail}
ASM data source asmpersonsource ${user.asmpersonsource}
ASM Deployment Program account name asmdepaccount ${user.asmdepaccount}
ASM managed Apple ID asmpersonmanagedappleid ${user.asmpersonmanagedappleid}
ASM passcode type asmpersonpasscodetype ${user.asmpersonpasscodetype}
ASM person ID asmpersonid ${user.asmpersonid}
ASM person status asmpersonstatus ${user.asmpersonstatus}
ASM person title asmpersontitle ${user.asmpersontitle}
ASM person unique ID asmpersonuniqueid ${user.asmpersonuniqueid}
ASM source system ID asmpersonsourcesystemid ${user.asmpersonsourcesystemid}
ASM student grade asmpersongrade ${user.asmpersongrade}
BES user email besuseremail ${user.besuseremail}
Company company ${user.company}
Company name companyname ${user.companyname}
Country c ${user.c}
Department department ${user.department}
Description description ${user.description}
Disabled user disableduser ${user.disableduser}
Display name displayname ${user.displayname}
Distinguished name distinguishedname ${user.distinguishedname}
Domain name domainname ${user.domainname}
Email mail ${user.mail}
First name givenname ${user.givenname}
Home address homestreetaddress ${user.homestreetaddress}
Home city homecity ${user.homecity}
Home country homecountry ${user.homecountry}
Home fax homefax ${user.homefax}
Home phone homephone ${user.homephone}
Home state/region homestate ${user.homestate}
Home zip or post code homezip ${user.homezip}
IP phone ipphone ${user.ipphone}
Middle initial middleinitial ${user.middleinitial}
Middle name middlename ${user.middlename}
Mobile mobile ${user.mobile}
Name cn ${user.cn}
Office address physicaldeliveryofficename ${user.physicaldeliveryofficename}
Office city l ${user.l}
Office fax number facsimiletelephonenumber ${user.facsimiletelephonenumber}
Office state/province st ${user.st}
Office street address officestreetaddress ${user.officestreetaddress}
Office telephone number telephonenumber ${user.telephonenumber}
Office zip or post code postalcode ${user.postalcode}
P.O. box postofficebox ${user.postofficebox}
Pager pager ${user.pager}
Primary group ID primarygroupid ${user.primarygroupid}
SAM account samaccountname ${user.samaccountname}
Street address streetaddress ${user.streetaddress}
Surname sn ${user.sn}
Title title ${user.title}
User logon name userprincipalname ${user.userprincipalname}