Global

Methods

---

createAppInventoryOpts(baseOpts, adminDeviceSpaceId, deviceUuids)

Convenience function to create an options object for MobileIron Device API call

Parameters:

Name	Type	Description
baseOpts	Object	Object containing basic connection properties. See createBaseOpts.
adminDeviceSpaceId	string	See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details. Try 1 if not sure.
deviceUuids	Array	Array of UUIDs of devices that should be queried. Maximum number is 25 if using getAppInventory(). See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

---

createAppInventoryStream(opts, batchSize)

Calls MobileIron's app inventory API as many times as possible to return a full inventory of the devices requested.

Parameters:

Name	Type	Description
opts	Object	Should contain baseUrl, username, password, adminDeviceSpaceId and deviceUuids. See createAppInventoryOpts().
batchSize	Number	Defines for how many devices the app inventory will be pulled at the same time. Default and maximum is 25. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

Returns:

Object (!) stream of the app inventory of devices that matched provided UUIDs. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

Type

InventoryStream

---

createBaseOpts(baseUrl, username, password)

Convenience function to create an options object for MobileIron API calls

Parameters:

Name	Type	Description
baseUrl	string	The URL of your MobileIron instance. Add /rest at the end if using connected cloud.
username	string	Admin user that has API access. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.
password	string	Admin user that has API access. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

---

createDevicesOpts(baseOpts, fields, query, adminDeviceSpaceId)

Convenience function to create an options object for MobileIron Device API call

Parameters:

Name	Type	Description
baseOpts	Object	Object containing basic connection properties. See createBaseOpts.
fields	Array	Array of strings listing all fields that should be returned. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.
query	string	Query to filter results. Can't be empty. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.
adminDeviceSpaceId	string	See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details. Try 1 if not sure.

---

getAppInventory(opts)

Queries MobileIron's app inventory API to retrieve the installed apps of the devices requested.

Parameters:

Name	Type	Description
opts	Object	Should contain baseUrl, username, password, and adminDeviceSpaceId deviceUuids. See createAppInventoryOpts().

Returns:

App inventory of devices that matched provided UUIDs. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

Type

Array

---

getDevices(opts)

Queries MobileIron's devices API to retrieve device information

Parameters:

Name	Type	Description
opts	Object	Should contain baseUrl, username, password, fields, query and adminDeviceSpaceId. See createDevicesOpts().

Returns:

All devices that matched query. All existing fields as keys.

Type

Array

---

ping(opts)

Pings a MobileIron instance's V2 API

Parameters:

Name	Type	Description
opts	Object	Should contain baseUrl, username, password. See createBaseOpts().

Returns:

MobileIron ping result, usually API and Core version. See MobileIronCoreV2APIGuideXX_RevXXXXXXXXX for details.

Type

Object