About this Guide

Introduction

This guide describes how to integrate your environment with MobileIron Cloud using the MobileIron Integration API. It is not intended to cover all possible API calls, rather those that will accomplish your desired use cases.

Assumptions

This guide assumes that you have:

· Some REST API experience

· An active MobileIron Cloud system

· The URL to your MobileIron Cloud system

· Tenant Admin credentials for making API calls

Revision History

Date

Description

March 3, 2021

Added the androidSecurityPatchLevel return field to the Get Device Details call.
Moved the apps configurations calls, Create Application Configuration and Update Application Configuration to the Apps API Calls chapter.
Added the call, Update In-House App Icons.
Added the call, Remove custom attributes per device - method 2. This method leaves in place custom attributes not specified in the call.
Removed rate limit guidance for the Get Application Inventory for a Particular Device call. There is no rate limit imposed for this call.
Clarified the description of the forceOverwrite parameter for the Patch custom attributes per device call.

January 22, 2021

Updated the sections API Limits and Get Application Inventory for a Particular Device, that MobileIron Cloud now limits this call to thirty calls per minute per user. Previous limit was three calls per minute per user.

November 16, 2020

Added the following response fields to the returns of selected Device API calls:

legalOwnerId
legalOwnerEmailAddress

October 28, 2020

Added GET custom attributes call.

October 27, 2020

Updated the section, API Limits.

October 3, 2020

Added the Get Connector status call.
Clarified use of rows parameter throughout guide. Do not send a value larger than 500 with the rows parameter because the APIs do not permit a value of greater than 500.
Added the managed field to the return of the Get Application Inventory for a Particular Device call.
Documented the ability to now use the device GUID as the identifier in the Get Device Details call.
Added the timeZone field to the return of the Get Device Details call.
Documented the enhanced Patch custom attributes per device call that allows updates of individual custom attributes, and addition of custom attributes.

August 19, 2020

Added the installedAt field to the return of the Get Application Inventory for a Particular Device call.
Added the ipAddress field to the return of the Get List of Devices Checked In Within x Amount of Time call.
Updated the Get Device Enrollment Program (DEP) details by DEP profile ID call.
Added the enabled parameter to the Change password call.
Added the esimIdentifier and bootstrapTokenAvailable fields to the return of the device details call.
Added the minOsVersion field to the return of the various app details calls in this guide.
Added the Get MDM profile call used when interacting with a custom Device Enrollment web page.

June 11, 2020

Added the passcodeCompliantWithProfiles response field to the following calls:
Updated the Response Fields section of the documentation for the call, Get iTunes App Info by appStoreId, to state that as of MobileIron Cloud 70, the displayVersion value matches the secondaryVersion value for iOS apps.

April 2, 2020

Described the new priority parameter and added it to the following calls:

02/13/20120

Updated the following calls:

Remove custom attributes per device - method 1: This call removes selected custom attributes, rather than removing all custom attributes.
Assign a Device to a User: Changed the deviceId parameter to deviceIds.

01/08/2020

Added the return fields currentCountryName and homeCountryName to the following calls:

11/05/2019

Added the accountIds and accountGroupIds parameters to the call, Install an App based on App Distribution Filters - iOS Only, which allow for custom distribution of the app.

10/02/2019

Added the following calls:

08/20/2019

Added the following calls:

06/03/2019

•

Added the availableCapacity and totalCapacity return fields to the call, Get List of Devices Registered Within x Amount of Time

•

Included that you can now use GUIDs as identifying parameters for the following calls:

Force check in a device or devices

Lock a device or devices

Get Custom Attributes Per Device

Add/Replace Custom Attributes Per Device

Patch custom attributes per device

•

Added the call, Remove custom attributes per device - method 1

02/07/2019

Added the following calls:

•

Configuration API Calls

•

Configuration API Calls

•

Configuration API Calls

01/22/2019

Added the following fields to the return of the GET device details calls: GUID, depEnrolled, depEligible.

12/4/2018

Minor: removed extra word in the Delete Device call description.

11/29/2018

Added the section, Sorting Results.

11/19/2018

• Updated the API Limits statement, clarifying usage of the rows and start parameters, and removing reference to the offset parameter, not used in this API.

• Updated Controlling Results to describe the rows and start parameters, and provided supporting examples.

11/7/2018

Updated the API Limits statement.

08/29/2018

•

Added the following calls:

Certificate Management Calls

Delete User-Provided Certificates in Bulk Using CSV File

Delete User-Provided Certificates in Bulk Using Using Account and Policy

•

Added descriptions of the mutable and MDMChannelId fields.

05/17/2018

Replaced instances recommending the GET api/v1/tenant call with the GET /api/v1/metadata/tenant call.

05/04/2018

Updated details returned by get device details calls.

03/02/2018

Added the following calls:

•

List User Groups

•

Check Delete Viability

•

Delete Group

02/01/2018

•

Added the Get Device Enrollment Program (DEP) details by DEP profile ID call.

•

Added the overrideUrl parameter to the Create an App and Update In-House App Details calls.

12/19/2017

•

Updated the Update In-House App Details call. Notably, added the mandatory primaryVersion and platformAppId parameters.

12/11/2017

•

Changed Update In-House App Screenshots call from PUT to POST.

•

Changed Create a Rule Group call to Create a Device Group.

11/14/2017

•

Added a statement about API Limits.

11/2/2017

•

In Apps API Calls, noted that all Apps API operations will apply to the default space only.

•

In the Get a List of In-House Apps call, updated the description of the cmPartitionId parameter.

•

For the Get Application Inventory for a Particular Device call, added a note that MobileIron Cloud limits this call to three per minute per user.

08/18/2017

Replaced the term “partition” with “space” in the explanatory sections of the text. The term “partition” remains in the API parameters and returns.

Added the following API calls:

Remove a Configuration from a Device

Delete a Configuration from the Uninstalled List

Push a Configuration to a Device

07/19/2017

•

Clarified the Update an App section by breaking it into two calls:

Uploading the new APK file

Copying Previous App Version Artifacts

•

Added the following calls:

Update User First Name, last Name, and Email Address

Update In-House App Screenshots

Update In-House App Details

Delete Device

Check Delete User Viability

Delete User

06/07/2017

•

Added the following calls:

Get All Accounts

Change Password

•

Updated the lastRegistrationTime date format in the Get List of Devices Registered Within x Amount of Time call to dd:hr:mm:ss from hr:mm:ss.

•

Added note that Basic Authentication is not supported with the Review and Rate an App call.

•

Clarified the behavior of the Add/Replace Custom Attributes Per Device and Patch Custom Attributes Per Device calls.

04/16/2017

Removed whitelisting requirements. No longer necessary.

03/03/2017

Added the following calls:

•

Create User without Password

•

Invite User

•

Import LDAP User

•

Check LDAP Import Status

•

Apply Custom Attribute to a User

•

List Devices by UID or Email Address