Android Details Key-Value Descriptions
The following table shows the key-value pairs in the <details> element for Android devices. The set of key-value pairs and the order they appear in the response can vary according to the type of device. Therefore, the table presents the pairs in alphabetical order by the key name.
If a key-value pair is not applicable for a device, typically the HTTP response does not include the pair.
The VSP Admin Guide has more information about fields that are available in the VSP Admin Portal.
|
Key Name |
Key Description | Value | ||||||
| admin_activated | Whether device administrator privilege is activated for the Ivanti client on the device. | truefalse | ||||||
| battery_life | Power remaining in the battery life. | The percentage of power remaining in the battery.Example: 100 | ||||||
| board | The name of the underlying board on the Android device. | A name that the Android OS provides.Example: venus2 | ||||||
| brand | The brand (e.g., carrier) the Android software is customized for, if any. | A string that the Android OS provides.Example: verizon | ||||||
| c2dmToken | Android C2DM registration ID for the device. | A string of characters | ||||||
| client_name | Name of Ivanti client application on the device. | Example: com.ivanti | ||||||
| client_version | Ivanti client version number running on the device. | Example: 4.5.0 | ||||||
| codename | Android platform’s current development codename, or the string "REL" if this is a release build. | Example: REL | ||||||
| country_code | The device’s Mobile Country Codes (MCCs). MCCs are defined in ITU E.212. | Example for United States: 310 | ||||||
| current_mobile_number | Phone number of the device | Example: 4089925779 | ||||||
| current_operator_name | Name of current registered operator. | Example: Verizon Wireless | ||||||
| current_SIM_module_number | International Mobile Subscriber Identity number for the device. | Example: 3100044085983632 | ||||||
| device | The name of the industrial design of the device. | A string that the Android OS provides.Examples: cdma_droid2cdma_shadow | ||||||
| device_id | Unique identifier for the device | Example: ddc865b69c13eeb4 | ||||||
| device_manufacturer | Manufacturer of the device. | Example: motorola | ||||||
| device_model | Model of the Android device | Example: DROID2 | ||||||
| device_roaming_flag | Whether the device is roaming. | on – The device is roaming.off -- The device is not roaming. | ||||||
| device_type | Whether the device uses CDMA or GSM technology to transmit voice calls. If the device does not transmit voice calls, this fields whether the device uses CDMA or GSM technology is transmit data. | CDMA or GSM | ||||||
| display_size | Size of the device’s display | Dimensions in pixels, in the format:<height>X<width>Example: 854X480 | ||||||
| free_media_card_size | Amount of unused storage on the media card on the device. | Number in bytesExample: 2.36M | ||||||
| free_media_card_size_bytes | Amount of unused storage on the media card on the device. | Number in bytesExample: 104857000 | ||||||
| free_ram_size | Amount of RAM available on the device. | Number of megabytes, shown with M suffix.Example: 5.84M | ||||||
| free_ram_size_bytes | Amount of unused RAM memory on the device. | Number in bytes.Example: 104857000 | ||||||
| free_storage_size | Amount of unused storage on the device | Number in bytesExample: 6489.68M | ||||||
| free_storage_size_bytes | Size of unused storage on the device. | Number in bytes.Example: 104857000 | ||||||
| home_operator | Home service provider for the device | The service provider name, mobile country code and mobile network code of the provider in the following format:<name>::<MCC+MNC> Example: Verizon::310004 | ||||||
| imei | International Mobile Equipment Identity of the device. | Example: A00000226EBF9F | ||||||
| imsi | International Mobile Subscriber Identity number for the device. | Example: 3100044085983632 | ||||||
| incremental | Android platform version’s build number. | Example: 110719 | ||||||
| kiosk_enabled | Indicates is kiosk mode is enabled on the device. The value is true or false. | Example:true | ||||||
| kiosk_user | Shows the username for the current Samsung kiosk user if multi-user is enabled in the VSP Kiosk policy applied to the device. | Examples:N/Ajsmith | ||||||
| lat_long_last_captured_at | The last time the location of the device was recorded. | Specified as seconds since January 1, 1970.Example: 1324421860972 | ||||||
| latitude | Latitude of the device’s location. | Degrees latitude.Example: 37.396074 | ||||||
| locale | Locale for the device | Examples: en-US en | ||||||
| longitude | Longitude of the device’s location. | Degrees longitudeExample: -122.056339 | ||||||
| mdm_enabled | Whether the Ivanti client is fully configured on the device. Note: The Ivanti client can be installed and running, but still unable to manage the device if it is not fully configured. | true – The Ivanti client is fully configured.false – The Ivanti client is not fully configured. | ||||||
| multi_mdm | Whether multiple Device Admin applications are active on the device. | true – More than one Device Admin application are active.False – One or zero Device Admin Applications are active. | ||||||
| network_id | CDMA network identification number. | Example: 6 | ||||||
| os_version | The Android SDK version code | Example: 10The value 10 corresponds to Android 2.3.3. Values are defined on http://developer.android.com. | ||||||
| platform_name | Android platform version number on the device. | Example: 2.3.3 | ||||||
| processor_architecture | Processor architecture of the device. | armeabi-v7a | ||||||
| prv_bluetooth | Whether the lockdown policy for the device has disabled access to Bluetooth. | ON – Access to Bluetooth is enabled for both audio and data.AUDIO – Access to Bluetooth is enabled for audio only.OFF – Access to Bluetooth is disabled.unsupported – The Ivanti client does not support enabling or disabling Bluetooth on the device. | ||||||
| prv_camera | Whether the lockdown policy for the device has disabled access to the camera. | ON – Access to the camera is enabled.OFF – Access to the camera is disabled.unsupported – The Ivanti client does not support enabling or disabling the camera on the device. | ||||||
| prv_device_encryption | Whether the security policy for the device has enabled data encryption on the device. | on – Device encryption is enabled.off -- Device encryption is not enabled.unsupported – The Ivanti client does not support enabling or disabling data encryption on the device. | ||||||
| prv_exchange_Domain | Domain of the email server of the device’s user. | Email server domain. For example: IVANTIIf the email client is not yet configured, the value is na.If the email client is not supported by Ivanti, then the response does not include this key-value pair. | ||||||
| prv_exchange_Serverfree_media_card_size | Email server for the device’s user. | Email server address.For example: mail.ivanti.comIf the email client is not yet configured, the value is na.If the email client is not supported by Ivanti, then the response does not include this key-value pair. | ||||||
| prv_exchange_UserName | Email user name of the device’s user. | Email user name. For example: [email protected]If the email client is not yet configured, the value is na.If the email client is not supported by Ivanti, then the response does not include this key-value pair. | ||||||
| prv_exchange_UseSSL | Whether email transport uses Secure Socket Layer. | ON – Email uses the Secure Socket Layer. The value is ON if Ivanti supports the email client and the email client is configured.If the email client is not yet configured, the value is na.If the email client is not supported by Ivanti, then the response does not include this key-value pair. | ||||||
| prv_kiosksettings | The name of the kiosk app settings policy applied to the device. | Example:CompanyXKioskSettings | ||||||
| prv_kioskpolicy | The name of the kiosk policy applied to the device. | CompanyXKioskPolicy | ||||||
| prv_max_failed_attempts | Maximum number of times the user can enter an incorrect password before the device is wiped. | The maximum number, or the value 0 if no maximum exists.This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_max_idle_time | Maximum time the device can be inactive before the user must re-enter the password. | Number of minutesExample: 30This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_password | Whether both of the following conditions are true:
|
ON – Both conditions are true. OFF – One or both of the conditions are not true. |
||||||
| prv_password_expiration_timeout | Numbers of days after which the device’s password will expire. | The number of days, or the value unsupported if a password is optional.Example: 30This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_password_history_length |
Number of passwords remembered to ensure that the devices user define a different password. For example the value4 prevents the user from repeating a password for the next four password. |
A number, or the value unsupported if a password is optional.This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_password_length | Minimum length for the devices password. | Number between 1 and 10, or -1 which indicates the password has no minimum length.This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_password_minimum_symbols | Minimum number of specialcharacters that must be included in a password. Applicable only to Android 3.0 and higher. | A number or the value unsupported if no minimum is required.This value is applicable only if prv_password_type indicates that a password is mandatory. | ||||||
| prv_password_type | Whether the device’s password is mandatory, and whether it must be restricted to simple numeric input, alphanumeric characters,or has no restrictions. The security policy assigned to the device specifies the password type. | 0 – password is mandatory and is restricted to alphanumeric characters.1 – password is mandatory and is restricted to simple numeric characters.2 – password is mandatory and has no character restrictions.-1 – password is optional. | ||||||
| prv_sd_encryption | Whether the security policy for the device has enabled encrypting the contents of the SD (Secure Data card) on the device. | on – SD encryption is enabled.off -- SD encryption is not enabled.unsupported – The Ivanti client does not support enabling or disabling SD encryption on the device. | ||||||
| prv_sdcard | Whether the lockdown policy for the device has disabled access to the SD card. | ON – Access to the SD card is enabled.OFF – Access to the SD card is disabled.unsupported – A lockdown policy is not applied to this device. | ||||||
| prv_vpn_servers | A list of VPN servers that the device can access. | List of semi-colon-separated VPN servers, each given as an IP address, a host name, or a URL. The value is na if the list is empty. | ||||||
| prv_wifi | Whether the lockdown policy for the device has disabled access to wireless LANs. | ON – Access to wireless LANs is enabled.OFF – Access to wireless LANs is disabled.unsupported – The Ivanti client does not support enabling or disabling access to wireless LANs on the device. | ||||||
| prv_wlan_ssids | Wireless local area network Service Set Identifiers for all wireless LANs configures on the device. | List of identifiers, separated by semi-colons.If none, then the value is na. Example: Ivanti-Guest;Ivanti-Test | ||||||
| registration_imsi | International Mobile Subscriber Identity number for the device. | Example: 3100044085983632 | ||||||
| registration_operator_name | The name of the service provider for the device. | Example: Verizon | ||||||
| regUuid | Device’s unique ID. | Example: ddc865b69c13eeb4 | ||||||
| Samsung_DM | Samsung device information for Samsung devices that support Samsung MDM APIs. | Example:FW: Key2,1 SW:1.0 | ||||||
| security_state | Indicates whether the device has been compromised. A compromised Android device means that the device has been rooted, which means that an application has root access to the device’s file system. | Ok – The device has not been compromised.Compromised – The device has been compromised. | ||||||
| SIM_module_number | International Mobile Subscriber Identity number for the device. | Example: IMSI:3104105000000000 | ||||||
| system_id | CDMA System Identification number | Example: 40 | ||||||
| total_media_card_size | Amount of storage on the media card on the device. | Number of megabytes, shown with M suffix.Example: 7574.19M | ||||||
| total_media_card_size_bytes | Amount of storage on the media card on the device. | Number in bytesExample: 785037745 | ||||||
| total_ram_size | Amount of RAM memory on the device. | Number of megabytes, shown with M suffix.Example: 475.93M | ||||||
| total_ram_size_bytes | Amount of RAM memory on the device. | Number in bytesExample: 504857000 | ||||||
| total_storage_size | Amount of storage on the device. | Number of megabytes, shown with M suffix.Example: 6700.98M | ||||||
| total_storage_size_bytes | Amount of storage on the device. | Number in bytesExample: 104857000 | ||||||
| usb_debugging | Allows Android debug mode, the adb interface of USB or network | Examples:onoff | ||||||
| wifi_mac_addr | Wi-Fi MAC address of the device. | Example: f87b7a29838f | ||||||
| wifimac_universal | A special Assemble variable that returns the WiFi Mac address of an Android, iOS, OS X or Windows device without having to specify the unique WiFi Mac variable name for each OS. | Example: f87b7a29838f |
iOS Details Key-Value Descriptions
The following table shows the key-value pairs in the <details> element for iOS devices. The set of key-value pairs and the order they appear in the response vary according to the type of device, such as iPhone or iPad. Therefore, the table presents the pairs in alphabetical order by the key name.
Note: In most cases, key names that have an underscore, such as security_state or Client_build_date, contain information that the device’s Ivanti client provides. Key names without underscores, such as allowUntrustedTLSPrompt or maxGracePeriod, contain information that the device’s operating system provides.
|
Key Name |
Key Description | Value |
| allowAppInstallation | Whether installation of applications is allowed. | Example: false |
| allowCloudBackup | Whether backing up the device to iCloud is allowed.Availability: iOS 5.0 and later. | true – Backing up to iCloud is allowed.false – Backing up to iCloud is not allowed. |
| allowCloudDocumentSync | When false, document and key-value syncing to iCloud is disabled. | Example: false |
| allowExplicitContent | Whether explicit music or video content purchased from the iTunes Store is hidden. Content is marked as explicit by content providers when sold through the iTunes Store. | true – Explicit content is not hidden.false – Explicit content is hidden. |
| allowInAppPurchases | Whether In-App purchases are allowed. | true – In-App Purchases are allowed.false - In-App Purchases are not allowed. |
| allowiTunes | Whether the iTunes Music Store is allowed on the device. | true – iTunes is allowed.false - iTunes is not allowed. |
| allowMultiPlayerGaming | Whether multiplayer gaming is allowed. | true – Multiplayer gaming is allowed.false - Multiplayer gaming is not allowed. |
| allowPhotoStream | Indicates whether the device’s Photo Stream is allowed on the device.Availability: iOS 5.0 and later. | true – Photo Stream is allowed.false – Photo Stream is not allowed. |
| allowUntrustedTLSPrompt | When false, automatically rejects untrusted HTTPS certificates without prompting the user.Availability: iOS 5.0 and later. | true or false |
| allowVideoConferencing | Whether videoconferencing is allowed on the device. | true - Videoconferencing is allowed.false – Videoconferencing is not allowed. |
| allowVoiceDialing | Whether voice dialing is allowed when the device is locked. | true – Voice dialing is allowed when the device is locked.false - Voice dialing is not allowed when the device is locked. |
| allowYouTube | Whether the YouTube application is allowed on the device. | true - YouTube is allowed.false – YouTube is not allowed. |
| apnsToken | The device’s APNs (Apple Push Notification service) token. | Example: 5c7b0866d6d068f8b4015690b83a6d1c00fb9484bdb00ea40d926bbade28de5f |
| AvailableDeviceCapacity | Floating-point gigabytes (base-1024 gigabytes). | Example: 13.765106201171875 |
| Battery Level | Floating-point percentage expressed as a value between 0.0 and 1.0, or -1.0 if battery level cannot be determined.Availability: iOS 5.0 and later. | Example: 0.10000000149011612 |
| battery_life | Power remaining in the battery life. | The percentage of power remaining in the battery.Example: 30 |
| BluetoothMAC | Bluetooth MAC address. | Example: B8FF617F7927 |
| BuildVersion | The iOS build number (8A260b, for example). | Example: 8J3 |
| CarrierSettingsVersion | Version of the currently-installed carrier settings file. | Example: 11.0 |
| CellularTechnology | Returns the type of cellular technology.Availability: iOS 4.2.6 and later. | Example: GSM |
| CheckOut Received | The VSP has received a checkout message from the device. This message indicates that the MDM profile was removed from the device. | true – The VSP has received a checkout message.false – The VSP has not received a checkout message. |
| Client_build_date | Build date of the Ivanti client. | Example: Apr 8 2011 12:02:24 |
| client_name | Name of Ivanti client application on the device. | Example: com.ivanti.phoneatwork |
| Client_version | Ivanti client version number running on the device. | Example: 4.5.12.33698 |
| country_code | The device’s Mobile Country Codes (MCCs). MCCs are defined in ITU E.212 . | Example for United States: 310 |
| Current MCC | The device’s Mobile Country Codes (MCCs). MCCs are defined in ITU E.212 . | Example for United States: 310 |
| Current MNC | Current Mobile Network Code. If the device is not roaming, this is the same as the SIM MNC. | Example: 00 |
| DataRoamingEnabled | Whether Data Roaming is enabled. | Example: false |
| device_id | The International Mobile Equipment Number for an iPhone. | Example: IMEI:012537000804721 |
| device_manufacturer | Device manufacturer. For iOS devices, the value is always Apple. | Example: Apple |
| device_model | Model of the iOS device. | Examples: iPad1,1iPhone3,1 |
| device_type | Whether the device uses CDMA or GSM technology to transmit voice calls. If the device does not transmit voice calls, this fields whether the device uses CDMA or GSM technology is transmit data. | CDMA or GSMExample: GSM |
| DeviceCapacity | Floating-point gibibytes (base-1024 gigabytes). | Example: 14.020126342773438 |
| DeviceCompromised | Whether the device is compromised. | true – The device is compromised.false – The device is not compromised. |
| DeviceName | The name given to the device via iTunes. | Example: Joe B’s iPad |
| forceEncryptedBackup | Whether the device forces encrypted backups. | true or false |
| free_storage_size_byte | Size of unused storage on the device. | Number in bytes.Example: 14780170240.000000000000000 |
| HardwareEncryptionCaps | Describes the underlying hardware encryption capabilities of the device. | The value represents a bit field with following meanings:1 – block-level encryption2 – file-level encryptionTherefore, because these are bit field values, the value 3 means both block-level and file-level encryption. |
| imeiNote:The detail name imei is no longer used for iOS in VSP 5.x. Use iPhone IMEI or ImeiOrMeid instead. | The device’s IMEI number. Ignored if the device does not support GSM. | Example: 011981001429081 |
| iPhone IMEINote:The detail name imei is no longer used for iOS in VSP 5.x. Use iPhone IMEI or ImeiOrMeid instead. | The device’s IMEI number. Ignored if the device does not support GSM. | Example: 011981001429081 |
| ImeiOrMeidNote:The detail name imei is no longer used for iOS in VSP 5.x. Use iPhone IMEI or ImeiOrMeid instead. | The device’s IMEI number. Ignored if the device does not support GSM. | Example: 011981001429081 |
| *ios_app_connected*This key requires a user account with both the API role AND the roles Smartphones Inventory, Policies, Apps/File Catalogs and Smartphone Manager Settings. | The number of hours since the Ivanti app has last connected to the VSP.This key requires the setting vspdetails=yes in the .ini section [RuleNum]. | 61.05 |
| iOSBackgroundStatus | The status of background location multitasking on the device. | 0 – The device supports background location multitasking, and the user has enabled location services.1 – The device supports background location multitasking, but the user has disabled location services.2 – Background multitasking has been disabled by the privacy policy applied to the device. 3 – The device hardware does not support background multitasking. 4 – The iOS version is earlier than 4.0, and therefore does not support background multitasking.Example: 3 |
| ip_address | IP address of the device. | Example: 192.168.1.174 |
| iPhone ICCID | The ICC identifier for the installed SIM card. | Example: 8949 2260 7349 2040 105 |
| iPhone IMEI | International Mobile Equipment Identity of the device. | Example: 01 253700 080472 1 |
| iPhone MAC_ADDRESS_EN0 | WIFI MAC address of device. | Example: b8:ff:61:7f:79:26 |
| iPhone PRODUCT | The model code for the device (iPhone3,1, for example). | Examples: iPad1,1 |
| iPhone UDID | The unique device identifier (UDID) of the iOS device. | Example: 81a3379d884f1bd9f1b0ce9b340358288081f7a1 |
| iPhone VERSION | The iOS build number of the iOS version that the device is running. | Example: 8J3 |
| it_policy_result | Not used. | Not used. |
| lat_long_last_captured_at | The last time the location of the device was recorded. | Specified as seconds since January 1, 1970.Example: 1325108114776 |
| latitude | Latitude of the device’s location. | Degrees latitude.Example: 50.645397 |
| locale | Locale for the device | Examples: en-US en |
| longitude | Longitude of the device’s location. | Degrees longitude.Example: 7.943374 |
| maxGracePeriod | Maximum grace period, in minutes, to unlock the phone without entering a passcode. The value 0 means no grace period is allowed; a passcode is required immediately. | Example: 900 |
| maxInactivity | Number of minutes for which the device can be idle (without being unlocked by the user) before it gets locked by the system. Once this limit is reached, the device is locked and the passcode must be entered. | Example: 300 |
| minLength | Minimum overall length of the passcode. | Example: 4 |
| mobile_number | Phone number of the device. | The mobile number, or the value (null) if the device has no mobile number.Example: +491718169911 |
| Model | The device’s model number. | Examples: MC820LLMC603DN |
| ModelName | Name of the device model. | Examples: iPadiPhone |
| ModemFirmwareVersion | The baseband firmware version. | Example: 05.16.05 |
| os_version | The version of iOS that the device is running. | Example: iPhone OS 4.3.3 (8J3)iPhone OS 5.0.1 (9A405) |
| OSVersion | The version of iOS that the device is running. | Example: 4.3.3 |
| PasscodeIsCompliant | Set to true if the user's passcode is compliant with allrequirements on the device, including Exchange and other accounts. | true or false |
| PasscodeIsCompliantWithProfiles | Set to true if the user's passcode is compliant with requirements from profiles. | Example: true |
| PasscodePresent | Set to true if the device is protected by a passcode. | true or false |
| platform_name | For all iOS devices, this field has the value iPhone. | Example: iPhone |
| platform_type | Either iPad or iPhone. | Examples: iPadiPhone |
| processor_architecture | For iOS devices, the value is always ARM. | Example: ARM |
| ProductName | The model code for the device. | Examples: iPad1,1iPhone3,1 |
| ratingApps | Maximum rating for apps on the device, according to Apple’s ranking of apps. | Example: 1000 |
| ratingMovies | Maximum rating for movies on the device, according to Apple’s ranking of movies. | Example: 1000 |
| ratingTVShows | Maximum rating for TV shows on the device, according to Apple’s ranking of TV shows. | Example: 1000 |
| registration_imsi | International Mobile Subscriber Identity number for the device. | Example: (null) |
| registration_operator_name | The name of the service provider for the device. | The name of the service provider, or (null) if not applicable.Example:AT&T |
| safariAcceptCookies | Indicates Safari’s setting to accept cookies. | 0 - Never1 - From visited2 - Always |
| safariAllowPopups | Indicates whether Safari is set to allow pop-ups. | true – popups are allowed.false – popups are not allowed. |
| safariForceFraudWarning | Indicates whether Safari is set to enable fraud warning. | true – Fraud warning is enabled.false – Fraud warning is not enabled. |
| security_reason_code | Not used. | Not used. |
| security_state | Indicates whether the device has been compromised. | 0 – The device has been compromised.1 – The device has not been compromised. |
| SerialNumber | The device’s serial number. | Example: V5046DGHZ38 |
| signal_strength | The signal strength on the device. | A number representing the signal strength, given in dBm. |
| SIM MCC | Home Mobile Country Code (numeric string). MCCs are defined in ITU E.212 . | Example for United States: 310 |
| SIM MNC | The Mobile Network Code of the SIM card on the device. | Example: 0107 |
| SIMCarrierNetwork | Name of the home carrier network. | Example: Telekom.de |
| Subscriber Carrier Network | Name of the home carrier network. (ReplacesSIMCarrierNetwork.)Availability: iOS 5.0 and later. | Example: o2-de |
| Supervised | Indicates if the device is in Supervised mode. | Example: true |
| total_storage_size_bytes | Amount of storage on the device. | Number in bytes.Example: 15053996032.000000536870912 |
| WiFiMAC | Wi-Fi MAC address. | Example: B8FF617F7926 |
| wifimac_universal | A special Assemble variable that returns the WiFi Mac address of an Android, iOS, OS X or Windows device without having to specify the unique WiFi Mac variable name for each OS. | Example: f87b7a29838f |