Object models
The following sections describe the response fields you will encounter using the APIs.
Do not perform strict type checking against the API JSON responses because Ivanti may enhance the responses with additional fields in subsequent releases.
App Catalog
|
Field name |
Description |
|
name |
Human readable name. |
|---|---|
|
platformType |
Type of OS platform. |
|
version |
Application version. |
|
identifier |
Application (unique) identifier. |
|
buildNumber |
Build number of the application. This is for in-house apps only. |
|
createdAt |
Time app was added. |
Application
|
Field name |
Description |
|---|---|
|
identifier |
Application (unique) identifier |
|
name |
Human readable name |
|
version |
Application version |
|
managed |
Is the application managed. |
|
source |
Source of the app, for example, PUBLIC. |
|
adHocCodeSigned |
true or false |
|
appStoreVendable |
true or false |
|
betaApp |
true or false |
|
deviceBasedVPP |
true or false |
|
externalVersionIdentifier |
The external version identifier, for example, 832990878. |
|
updateAvailable |
true or false |
|
installing |
true or false |
|
validated |
true or false |
|
shortVersion |
The short version, for example, 5.2.1. |
|
bundleVersion |
The bundle version, for example, 6733. |
Certificate
|
Field name |
Description |
|
identity |
Indicates the certificate is an identity certificate. |
|
notAfter |
Epoch time after which certificate expires. |
|
notBefore |
Epoch time before which certificate is not valid. |
|
issuer |
DName of the certificate issuer organization. |
|
serialNumber |
Unique identification number for the certificate. |
|
subject |
DName of the client to which the certificate belongs. |
|
thumbprint |
The thumbprint is a hexadecimal string uniquely identifying a certificate. A thumbprint algorithm calculates the thumbprint. CES accepts Secure Hash Algorithm 1 (SHA-1) thumbprints in the 40-digit hexadecimal string form without spaces. |
Device
Note: imei, imsi and macAddress may not be present in all devices.
|
Field name |
Description |
|
compliant |
"true" if the device meets the compliance rules established by the Ivanti enterprise administrator, else "false". |
|
quarantined |
"true" if the device is violating any policy with respect to quarantine action for device. |
|
blocked |
"true" if the device is violating a defined policy that has a compliance action. |
|
compromised |
"true" if the device OS is compromised as defined by rules established by the Ivanti enterprise administrator, for example, iOS device is jailbroken or an Android device is rooted. |
|
Device registration state; one of: ACTIVE RETIRED WIPED WIPE_SENT UNKNOWN RETIRE_SENT ENROLLMENT_PENDING |
|
|
lastCheckInTime |
The timestamp of the last device check in (number of milliseconds from the epoch). This is the UEM check in time. |
|
registrationTime |
The timestamp of the device registration (number of milliseconds from the epoch). |
|
identifier |
The unique device UEM identifier for the device in question. UEM identifiers are consistent within an OS, but are not consistently formatted across OSs. This identifier is not present for MAM only and Auth only devices because MDM is required in order to provide this information. Use deviceGuid, described below, which is more reliably available. |
|
macAddress |
The device's MAC address, six groups of two hexadecimal digits separated by colons e.g. b0:65:bd:33:fe:2b. Available and valid only after the system fires the device.report_initialized event immediately after device enrollment. |
|
manufacturer |
Device manufacturer, e.g. samsung , Apple Inc. or MicrosoftMDG |
|
model |
Device model, e.g. Nexus 10 , iPad3,1 or Lumia 950 Dual SIM |
|
os |
The devices operating system; one of: ANDROID IOS OSX WINDOWS UNKNOWN |
|
osVersion |
The OS version. |
|
serialNumber |
Device serial number. |
|
userId |
User name of the user the device belongs to. |
|
userUuid |
User unique identifier, can be used with user APIs like Update user attributes. |
|
iosUdid |
The UDID number for iOS device. |
|
The device GUID of the device. |
|
|
customAttributes |
All custom device attribute fields that have been set with a value for the device will be listed. |
|
ownership |
Indicates whether the device is company-owned or employee-owned, or the ownership type is unknown. Returns one of the following values: COMPANY, EMPLOYEE, UNKNOWN |
|
imei |
The device International Mobile Station Equipment Identity number. See http://www.imei.info/faq-what-is-IMEI/. |
|
imsi |
The IMSI number for the device. |
|
phoneNumber |
Phone number. |
Device event
|
Field name |
Description |
|
timestamp |
milliseconds since the epoch: January 1, 1970 |
|
eventType |
one of the following: Fired only when the device enrolls and the UEM server receives the security status of the device. If the Security status changes, the UEM server processes the change, but does not fire this event. For Android devices managed by Ivanti Neurons for MDM, to include the IMEI value in Android devices' device.report_initialized events, go to Admin > Android → Registration on the MobielIron Ivanti Neurons for MDM Admin portal and enable Require Android device identifiers during registration (Work Profile & Device Admin).This is supported for Android 6.0 devices and above. •device.enrolled •device.check_in •device.not_compliant •device.compliant •device.retired •device.app_inventory •device.cert_inventory •device.profile_inventory •device.wiped |
|
devices |
A list of devices. |
Profile
|
Field name |
Description |
|
encrypted |
Indicates whether the profile payload content is encrypted or not |
|
hasRemovalPasscode |
Indicates whether the profile has a removal passcode |
|
managed |
Indicates whether the profile is managed by Ivanti |
|
removalDisallowed |
Supervised only. If present and set to true, the user cannot delete the profile (unless the profile has a removal password and the user provides it) |
|
content |
Array of payload dictionaries. Not present if 'encrypted' is true. |
|
description |
A description of the profile |
|
displayName |
Friendly name that identifies the entity. |
|
identifier |
A reverse-DNS style identifier (com.example.myprofile, for example) that identifies the profile |
|
organization |
A human-readable string containing the name of the organization that provided the profile |
|
uuid |
A globally unique identifier for the profile |
|
version |
The version number of the profile format |
Rules
These are the rules used to create device groups on Ivanti Neurons for MDM and labels on Ivanti EPMM.
|
Field name |
Description |
|
id |
Unique identifier for rule group |
|
name |
Rule name |
|
description |
Rule group description |
|
definition |
Filter criteria for rule |
User
|
Field name |
Description |
|
enabled |
Indicates whether or not the user is enabled in the system. |
|
createdAt |
Epoch time when the user was on-boarded into the system. |
|
accountSource |
AccountSource enum. |
|
displayName |
Display name of the user. |
|
emailAddress |
Registered email address of the user. |
|
firstName |
User first name. |
|
lastName |
User last name. |
|
userId |
User name. This is the field by which you can search or count users. |
|
userUuid |
User unique identifier, to be used for the API call, Update user attributes. |
|
customAttributes |
All custom user attribute fields that have been set with a value for the user will be listed. |
|
ldapCustomAttributes |
All LDAP custom attribute fields that have been set with a value for the LDAP user will be listed. |
Sign out
|
Field name |
Description |
|
timestamp |
|
|
eventType |
device.user_signout |
|
devices |
|
| compliant | |
| quarantined | |
| blocked | |
| compromised | |
| status | |
| lastCheckInTime | |
| registrationTime | |
| identifier | |
|
imei |
|
|
macAddress |
|
|
manufacturer |
|
|
model os |
|
|
osVersion |
|
|
serialNumber |
|
|
userId |
|
|
userUuid |
|
|
iosUdid |
|
|
deviceGuid |
|