API Reference Document for
MobileIron WebService
for MobileIron Core 10.8.0.0

September 8, 2020

Proprietary and Confidential | Do Not DistributeCopyright © 2009 - 2019 MobileIron, Inc. All Rights Reserved.
Any reproduction or redistribution of part or all of these materials is strictly prohibited. Information in this publication
is subject to change without notice. MobileIron, Inc. does not warrant the use of this publication. For some phone
images, a third-party database and image library, Copyright © 2007-2009 Aeleeta's Art and Design Studio, is used.
This database and image library cannot be distributed separate from the MobileIron product.
“MobileIron,” the MobileIron logos and other trade names, trademarks or service marks of MobileIron, Inc.
appearing in this documentation are the property of MobileIron, Inc. This documentation contains additional trade
names, trademarks and service marks of others, which are the property of their respective owners. We do notintend our use or display of other companies’ trade names, trademarks or service marks to imply a relationshipwith, or endorsement or sponsorship of us by, these other companies.

API Reference Document for MobileIron WebService| ii

Contents
Important Note on v1 API Deprecation

1

Deprecation update - September 8, 2020

1Document Overview

2

General Guidelines and Conventions

3

Parameter Formats

3

Path Parameters

3

Query parameters

3

Date Formats

4

Phone Number Formats

4

HTTP request methods

4

Response Formats

4

HTTP Response Codes

5

Using offset and limit Parameters to Cycle through Records

5

Device and User Identifiers

6

Operating System Dependencies

6

Supported Browsers and Recommended Plugins

7

General Practice7

Authentication

8

Username/Password

8

WADL

9

Device Management

10

Status and statusCode values

10Compliance, quarantinedStatus, and blockReason values

10

Get Devices by Status

12

Get Device details for a specific device

18

Android Details Key-Value Descriptions

24

iOS Details Key-Value Descriptions

34

API Reference Document for MobileIron WebService| iii

Exporting Device Information to a CSV

48

Get Device Details for a Phone Number/User/Label/Wi-Fi MAC Address

49

Register a Device

57

Retire a Device

61

Lock a Device

62

Unlock a Device

64

Wipe a Device

67

Wakeup Client

69

Locate a Device

70

Enable Roaming73

Get all Labels

75

List of Operators

77

List of Countries

78

Send Action to bulk devices

80

Send message to devices

83

Get Profiles for a Device

86

Re-push Profiles for a Device

89

Exchange ActiveSync (EAS)91

List All ActiveSync Devices

91

Device Details for ActiveSync

94

Request Action on ActiveSync Device

99

Security Management

101

Update Password for a User

101

Find a User

103

Search LDAP Users

105

Authenticate a User

108

Alerts112

Get All Alerts

112

Get All Alerts for Phone Number

116

API Reference Document for MobileIron WebService| iv

Get all Alerts for User

119

Get All Alerts for a Phone Number of a User

122

Update Alert

125

Update List of Alerts

126

Policies

128

Get Policies

128

Get Policies by DeviceUUID

130

Apply/Remove policy for a label.

132

Policy Rules

133

Security policy rules

134

Lockdown policy rules

146

Sync policy rules

147

Privacy policy rules

150

Application Settings

154

Get all Application Settings

154

Get Application Settings by Device UUID

158

AppConnect for iOS and Android Analytics

162

Get Analytics for AppConnect Apps

162

Testing from a browser

164

Test Client

165

Change Log

167

API Reference Document for MobileIron WebService| v

1Important Note on v1 API Deprecation
MobileIron is deprecating some v1 APIs in favor of their new v2 API counterparts and MobileIron will notconcurrently support some of the deprecated v1 versions. Please see this KB article for details.

Deprecation update - September 8, 2020
MobileIron has removed the documentation for the APIs listed in the following table and urges you to use thecorresponding v2 versions. MobileIron is working to deprecate these APIs six months to a year from September 8,
2020.
V1 API Documentation Removed from this ManualCorresponding V2 AP1

GET /api/v1/dm/labels/devices/<device-uuid>

GET /api/v2/devices/{deviceGuid}/labels?adminDeviceSpaceId={adminDeviceSpaceId}.
See "Get list of labels for a specific device" in the
MobileIron V2 API Guide available on this page.

ll

PUT /api/v1/dm/labels/{label-name}/{deviceid}?action=applyl

PUT /api/v1/dm/labels/{label-name}/{deviceid}?action=removelPUT
api/v2/devices/labels/label1,label2/add.
See "Apply labels to devices" in the
MobileIron V2 API Guide available on this
page.
PUT
api/v2/devices/labels/label1,label2/remove.
See "Remove labels from devices" in the
MobileIron V2 API Guide available on thispage.

API Reference Document for MobileIron WebService| 12Document Overview
This document provides development information for customers and partners intending to use MobileIron
WebService APIs.
The initial sections provide general guidelines and conventions for reference.
The main part of the document includes API descriptions, which are categorized as follows:
•
•
•
•
•
•
•

Exchange ActiveSync – retrieves detailed information for EAS devices and provides a way to act on thosedevices.
Security management –helps a user with password protection.
Alerts – allows for alert retrieval and updates.
Applications – provides an inventory of installed applications.
Policies
Application settings
AppConnect analytics

Each of the above categories contains one or more API calls. In most cases, there is an API description, a URI, a
set of mandatory or optional request parameters, response status codes, and the response (with example data
included). The input parameters and output response include definitions where necessary. Please refer to the
Administration Guide for additional background and details on how these functions behave in the UI.
The end of the document includes a sample http test client implemented in Java.

API Reference Document for MobileIron WebService| 2

3

General Guidelines and Conventions
Parameter Formats
The HTTP requests use two types of parameters:••

Path parameters
Query parameters

Path Parameters
Path parameters continue the URI path using a slash (/) for a separator. For example, to get details for a device,
you specify its device uuid with a path parameter. The following shows the URI format for this request, and an
example:https://{host-name}/api/v1/dm/devices/{deviceuuid}
https://mycore.mobileiron.com/api/v1/dm/devices/4239b999-46e3-423b-b808-54fff69b544c

If a request uses path parameters, they are specified in the URI format for the request.

Query parameters
Query parameters are included in the URI path using a question mark or ampersand (? or &). For example, to retirea device, after specifying the device uuid as a path parameter, you specify a reason as a query parameter. The
following shows the URI format for this request, and an example:
https://{host-name}/api/v1/dm/devices/retire/{deviceuuid}
https://mycore.mobileiron.com/api/v1/dm/devices/retire/c097c9e2-c82e-40f6-9e69a0478c4fcee0?reason=AnyReasonTextYouChoose

The first query parameter is preceded by a question mark (?), using the following format:?parameterName=parameterValue
Subsequent query parameters are preceded by an ampersand (&), using the following format:&parameterName=parameterValue
For example, to get all the Android devices that have a particular application installed, use the following request:
https://mycore.mobileiron.com/api/v1/apps/inventory/app?appname=Frog%20Toss!_
017%201.0&platform=A
Note: If a parameter is not shown in a request’s URI format with a slash, it is a query parameter; the URI format fora request shows only the path parameters. The description that follows each URI format provides information on
the query parameters, if any.

API Reference Document for MobileIron WebService| 3

General Guidelines and Conventions

Date Formats
Many API calls include start and end dates in the request. In general, the dates are optional. If dates are notincluded, all available records will be returned. If start and end dates are included in the request, only records within
the date range will be returned.
Dates can be in the following formats
•
•
•
•
•

Jan 1 2010
January 1, 2010
January 1, 2010, 00:00:00
UTC format: YYYY-MM-DDThh:mm:ssTZD- For example: 2010-03-10T15:04:06+00:00 which is March 10, 2010 3:04:06 PM
Alternate format: MM-DD-YYYY hh:mm:ss- For example: 03-12-2010 13:23:12 which is March 12, 2010 1:23:12 PM

Phone Number Formats
Many API calls require a phone number in the request. The following rules apply to an input phone number:•••Enter numbers only.
Do not include a country code.
Do not include parenthesis, dashes, periods, or other special characters.

HTTP request methods
Depending on the HTTP request, use one of the following HTTP request methods:•••

Get – Use for requests that retrieve information from MobileIron Core.
Put – Use for requests that change information on MobileIron Core.
Post – Use for the bulk requests that perform actions on many devices, or for requests that provide substantial
information on MobileIron Core.

Each request description specifies which HTTP request method to use.

Response Formats
Requests to the API can return xml or json, based on the request headers.
••

For xml output, set the ‘Accept’ header in the request to ‘application/xml’.
For json output, set the ‘Accept’ header in the request to ‘application/json’.

API Reference Document for MobileIron WebService| 4General Guidelines and Conventions

HTTP Response Codes
Responses from the API use the codes listed below. In addition, a “Success” message is shown for successful
method executions. When method executions fail, a descriptive error message is displayed.
•
•
•
•
•
•
•

200 OK: Success
400 Bad request: The request was invalid. The accompanying error message in the output explains the reason.
401 Unauthorized: Authentication to the API has failed. Authentication credentials are missing or wrong.
404 Not found: The requested resource is not found. The accompanying error message explains the reason.
405 Method Not Allowed: The HTTP request method that was specified is not the correct method for therequest.
500 Internal Server Error: An internal server error has occurred while processing the request.
502 Bad Gateway: The MobileIron server is not reachable.

Using offset and limit Parameters to Cycle through Records
Some requests result in responses that contain many records. For example, the request for the list of all devices on
which a specific application is installed can match hundreds or thousands of devices.
To return more than the first 100 records, these APIs support the limit and offset query parameters. These
parameters allow you to get successive sets of records in successive responses.
Specifically, use these query parameters to do the following:•

Limit the number of records returned in the response to a number you choose, using the query parameter limit.
For example, the following request returns the first 50 devices that have the LinkedIn app installed:
https://
mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50•

Specify the index of the first record to return in the response, using the query parameter offset.
The value is zero-based. For example, the following request returns 50 devices, starting with the 101st device:https://
mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50&offset=100

The offset parameter defaults to 0. Therefore, both of the following requests return 50 devices, starting with thefirst device:https://
mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50&offset=0
https://
mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50

Therefore, to get successive sets of records in successive responses, increase the offset value by the limit value
in each request. For example:
https://mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50&offset=0
https://mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50&offset=50
https://mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=50&offset=100

API Reference Document for MobileIron WebService| 5General Guidelines and Conventions

For the API that gets the devices that have a particular app installed (Get Devices by Application Name), you canalso set limit to -1 to get all the devices in one response. For example:
https://mycore.mobileiron.com/api/v1/apps/inventory/app?appname=LinkedIn&limit=-1

The following table summarizes the limit and offset query parameters.
Query

Description

Default value

Special value

Maximum number

100

-1

show in the

Note: This default value applies only to APIs thatShows all records in

response.

support the limit query parameter. Other APIs

the response.

parameter
limit

of records toalways return all applicable records in the
Note: This special

response.

value only applies totheapps/inventory/app
API.
offsetZero-based index

0of first record toshow in the
response

Device and User Identifiers
The requests and responses use identifiers for devices and users.
Every time a user or a device is created, MobileIron Core internally generates a unique identifier, called a “uuid”.
Each device gets a unique uuid. Because a single user can have multiple devices, each user gets a unique uuid,
independent of any devices used.
Other IDs are used for other purposes, such as identifying a network, and are described in the APIs.

Operating System Dependencies
Refer to the Administrator’s Guide for an up-to-date matrix which displays supported features by operating systemand platform. If a particular feature is not supported by an OS, the feature API will not return a valid response.

API Reference Document for MobileIron WebService| 6

General Guidelines and Conventions

Supported Browsers and Recommended Plugins
FireFox and Chrome are the supported browsers. Internet Explorer is not supported. Plugins like Poster for FireFox
and Advanced REST Client for Chrome are recommended for interacting with the http server; simply submitting a
URI in the browser does not consistently result in a properly rendered response.

General PracticeAll the requests are wrapped in WebServiceRequest, and the responses are wrapped in WebServiceResponse.
startDate and endDate from the request are returned in the response.

API Reference Document for MobileIron WebService| 74Authentication
Access to the web service is granted using roles. The ability to grant role access is available to administrators thatare assigned the role ‘Manage administrators and device spaces’. These Super Administrators can assign the‘API’ role to a user with the following steps:
1.
2.
3.
4.
5.

From the Admin Portal, select Admin > Admins.
Select a user from the list of users.
Select Actions > Edit Roles.
Select the ‘API’ role, which is listed under Others.
Click Save.

Username/Password
The web service requires authentication via username and password:••

Username: Username of any local or LDAP user who has the ‘API’ role.
Password: The same password used to login to MobileIron Core the Admin Portal.

API Reference Document for MobileIron WebService| 8

5

WADL
The WADL (Web Application Description Language) is an xml interface file between client and server. The WADL
file is present in the API test client zip file. To view the generated WADL, open the following URL from a browser:
https://{host-name}/api/?_wadl&_type=xml

API Reference Document for MobileIron WebService| 9

6Device Management
Device Management APIs allow administrators to retrieve a variety of details for devices based on varying search
criteria. These APIs can also register, retire, wipe, lock, unlock, locate, and wakeup a device. Lastly, labels,
countries, and operators can be retrieved from these APIs.

Status and statusCode values
Some Device Management APIs refer to device “status” and “statusCode” in either requests or responses.
Possible values for these variables are listed here:
status:
•
•
•
•
•
•
•
•
•
•
•

ACTIVE – Active devices
IENROLL_VERIFIED – Enrollment verified devices for iPhone and WebOSIENROLL_INPROGRESS – Enrolling devices for iPhone and WebOSIENROLL_COMPLETE – Enrolled devices for iPhone and WebOS
INFECTED – Virus Infected devices
LOST – Lost devices
RETIRED – Retired devices
VERIFIED – Registration Verified devices
VERIFICATION_PENDING – Verification Pending devices
EXPIRED – Expired devices
WIPED – Wiped devices

statusCode:
•
•
•
•
•
•
•
•
•
•
•
•

ACTIVE - 97
BLOCKED - 98
IENROLL_VERIFIED - 100
IENROLL_INPROGRESS - 101
IENROLL_COMPLETE - 102
INFECTED - 105
LOST - 108
RETIRED - 114
VERIFIED - 118
VERIFICATION_PENDING - 112
EXPIRED - 120
WIPED - 119Compliance, quarantinedStatus, and blockReason values
The APIs which return information about a device include these fields:

API Reference Document for MobileIron WebService| 10

Device Management•••<compliance><quarantinedStatus><blockReason>

The value of each of these fields appears in the response as a decimal number that represents a bitmap value.
Each bit in the value represents a reason why the device is not in compliance, has been quarantined, or has been
blocked from accessing the ActiveSync server.
The following table shows when each of these fields is non-zero:
Field

Value

<compliance>

The value is non-zero if the device is not in compliance as specified by its security
policy.

<quarantinedStatus>

The value is non-zero if the device is not in compliance as specified by its security
policy, and the setting that is not in compliance specifies an action that includes
quarantining the device.

<blockReason>

The value is non-zero in the following cases:••

The device is not in compliance as specified by its security policy, and the settingthat is not in compliance specifies an action that includes blocking access to theActiveSync server.
The administrator has manually blocked the device’s access to the ActiveSync
server. This action is available in MobileIron Core Admin Portal, at Users &Devices | ActiveSync Associations.

Note: If multiple reasons apply, the corresponding bit values are summed. For example, if the device has been
compromised (value 1), and its OS version is less than the required version (value 2), then the field has the value 3.
The following table shows all the possible bitmap values for the <compliance>, <quarantinedStatus>, and<blockReason> fields:
Hexadecimal

Decimal

value

value

0x0000000

Description

Device is in compliance.

Note: Jailbroken Android devices have the compliance value 0, but the security_
state field in the Android device details has the value “compromised”.
0x000001

1

Device is compromised.

0x000002

2

OS version is less than the supported OS version.

API Reference Document for MobileIron WebService| 11

Device Management

Hexadecimal

DecimalDescription

value

value

0x000004

4

Hardware version is not allowed.

0x000008

8

Data Protection is not enabled.

0x000020

32

Device is out of contact.

0x000040

64

App control policy is out of compliance.

0x000080

128

Device exceeds per mailbox limit.

0x000100256

Device is not registered.

0x000200

512

Device is manually blocked.

0x000400

1024

Exchange Reported.

0x000800

2048

Device administrator is deactivated.

Note: On an Android device, the device administrator is deactivated. On iOS 5.0
and higher, the MDM profile has been removed, which deactivates MDM on thedevice.
0x001000

4096

Disallowed app control policy is out of compliance.

0x002000

8256

Required app control policy is out of compliance.

0x000010

8272

Policy is out of date.

0x004000

16384

Allowed app control policy is out of compliance.

0x008000

32768

User logged out.

0x10000

65536

Attestation Failed.

0x400000

4194304

Unknown reason.

Get Devices by Status
A device within the MobileIron system travels through a variety of different states, each of which can be retrieved
through an API call. States such as enrollment-in-progress, active, retired, lost, or wiped can be retrieved. This
API returns all devices that match the requested status type. If the status is not specified, all devices with ‘Active’
status are returned.

API Reference Document for MobileIron WebService| 12

Device Management

Examples:Get all devices with the status ACTIVE:
https://mycore.mobileiron.com/api/v1/dm/devices

Get all devices with the status LOST:
https://mycore.mobileiron.com/api/v1/dm/devices?status=LOST

URI:

Devices with the input status are returned.

https://{host-name}/api/v1/dm/devices
Http Method:

GET

Format:xml, json

Request:Status

Optional.
See list of valid values above.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><messages><message>212 Device(s) returned</message>

Status message.

</messages><devices><device id='2’><uuid>8d711cdc-e93c-49b1-88d6-

Unique identifier for the device.

222f54132445</uuid><principal>jdoe</principal>

User ID for the user of the device. This
corresponds to the user ID in the MobileIron Core
Admin Portal, as seen in Users & Devices | Users.

<blockReason>0</blockReason>

A bitmap value that lists the reasons, if any, thatthe device is blocked from accessing the

API Reference Document for MobileIron WebService| 13

Device Management

ActiveSync server. The possible values aredescribed in Compliance, quarantinedStatus, andblockReason values<clientId>1073741831</clientId>

For MobileIron Core internal use.

<comment>comment for the device</comment>

Comment entered by the administrator.

<compliance>0</compliance>

A bitmap value that lists the reasons, if any, thatthe device is out of compliance with its security
policy. The possible values are described inCompliance, quarantinedStatus, and blockReason
values.

<countryCode>1</countryCode>Country code for the device.

<countryId>183</countryId>

Country identifier for the device. MOBILEIRONCORE assigns this identifier to the country.

<countryName>United States</countryName>Country name for the device.

<details>

Device details, which consist of key-value pairs.
The set of key-value pairs vary by the make,model, and operator of the device. The set shownis only an example.

For more information, see Android Details KeyValue Descriptions and iOS Details Key-Value
Descriptions.

If device registration is pending, then the details
section is empty.
<entry><key>device_model</key><value>DROIDX</value></entry><entry>API Reference Document for MobileIron WebService| 14

Device Management<key>platform_name</key><value>2.2</value></entry><entry><key>Client_version</key><value>4.2.0</value></entry></details><deviceCount>1</deviceCount>Not used. Always 0.

<easLastSyncAttempt>2012-01-

Time of the last attempt the device made to

10T20:36:57+00:00</easLastSyncAttempt>

synchronize with Exchange ActiveSync.

<easUuid>4d22d6d7-29dc-4c35-8e67-

Exchange ActiveSync device id.

23dee442cf85</easUuid><emailAddress>jdoe@mobileiron.com</emailAddress>

The user’s email address as entered during
registration.

<emailDomain>txt.att.net</emailDomain>

Email domain of the operator for the device.

<employeeOwned>false</employeeOwned>true - the employee owns the device.
false - the enterprise owns the device.

The value is set during registration and theadministrator can change it.
<homeOperator>Verizon</homeOperator>

The service operator for the device when it is not
roaming.

<languageCountryId>0<languageCountryId>

The unique identifier for the country associatedwith the language used on the device. For
example, there would be a different ID for a
Canadian French language device when compared
to a device from France.

API Reference Document for MobileIron WebService| 15

Device Management

MobileIron Core assigns this identifier to thecountry.
<languageId>1</languageId>

The unique identifier for the language used on thedevice.

<lastConnectedAt>2011-07-

The date and time that the device last made08T01:52:33+00:00</lastConnectedAt>

successful contact with the MobileIron server.

For iOS devices that have iOS MDM enabled, thisvalue is the time of the last iOS MDM checkin.
<manufacturer>Research In Motion</manufacturer>

The device manufacturer as automatically reportedby the device during registration.

<mdmManaged>false</mdmManaged>

Indicates that the MDM profile is enabled on thedevice. This field applies only to iOS devices. For
other devices, the value is always false.

<mdmProfileUrlId></mdmProfileUrlId>

MOBILEIRON CORE internal ID for its iOS MDM
profile information.

<model>8130</model>

The model of the device as reported by the device
during registration.

<name>jdoe:Android 4.4:PDA 2</name>

The concatenated name used to identify thedevice/user combination.

<notifyUser>true</notifyUser>true indicates the user should be notified via email
during registration. This does not control whether
MobileIron Core sends an SMS message given a
valid phone number, which it always does.

false indicates the user should not be notified.

The notification consists of the principal name,platform, and phone number.
<operator>AT&T</operator>

Service provider for the device. The value PDA
indicates no operator is associated with the

API Reference Document for MobileIron WebService| 16

Device Management

device.
<operatorId>269</operatorId>

Identifier of the operator for the device.
MOBILEIRON CORE assigns this identifier to theoperator.

<phoneNumber>4085551212</phoneNumber>

The phone number entered by the user oradministrator during registration.

<pin>2732E6DB</pin>

Unique identification number for a BlackBerrydevice. Not available for other devices.

<platform>Android 4.4</platform>

String indicating the platform installed on thedevice. The string is specified during registration.

<quarantinedStatus>0</quarantinedStatus>

A bitmap value that lists the reasons, if any, thatthe device is quarantined. When a device isquarantined, its configurations (that is, profiles)
have been removed due to violations with its
security policy.

The possible values are described in Compliance,
quarantinedStatus, and blockReason values.
<regCount>0</regCount>

For Blackberry, after the MobileIron client isdownloaded, the VSP sends the provisioning SMS
message to the client. If the client fails to connect,
then the VSP resends the message at a scheduledinterval. This value indicates how many times the
VSP sent the provisioning message to the client.

<regType>DEFAULT</regType>

This value applies only to BlackBerry devices,
indicating the registration type configured on
MobileIron Core. Possible values are:
DEFAULT: Register/Deploy via MobileIron
BES: Register via MobileIron, Deploy via BES
BESAUTO: Register/Deploy via BES 5.x<status>ACTIVE</status>

String indicating the current status of the device
with regard to registration and connection. For

API Reference Document for MobileIron WebService| 17

Device Management

valid values, see Status field above.
<statusCode>97</statusCode>Numeric code defined for the status. See list ofvalid values above.

<userDisplayName>Joe Doe</userDisplayName>

The concatenation of the user’s first name and last
name as defined during registration.

<userFirstName>Joe</userFirstName><userLastName>Doe</userLastName><userSource>76</userSource>

Value 76 for a Local user.

Value 68 for an LDAP user.

Note:
76 is the value of ASCII ‘L’, which stands for Local.
68 is the value of ASCII ‘D’, which stands for
Directory (LDAP).
<userUUID>de398fcb-a3a4-412c-a1dd-

Internal user ID.

9be8bd46e728</userUUID><iPhoneVersion>8J2</iPhoneVersion>

Version number of iPhone.

</device></devices></deviceManagementWebServiceResponse>

Get Device details for a specific device
Example:https://mycore.mobileiron.com/api/v1/dm/devices/12849438-0d74-3c30-6b7d-121a3da8645d

API Reference Document for MobileIron WebService| 18

Device Management

URI:

Devices with the input status are returned.

https://{host-name}/api/v1/dm/devices/{deviceuuid}
Http Method:

GET

Format:xml, json

Request:Deviceuuid

Unique identifier for the device. Only one uuid
can be passed at a time.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse></messages>

Empty if the device specified exists.
Otherwise, a <message> element is included
indicating that no device was found.

<device id='2’><uuid>8d711cdc-e93c-49b1-88d6-222f54132445</uuid>

Unique identifier for the device.

<principal>jdoe</principal>

User ID for the user of the device. This
corresponds to the user ID in the MobileIron
Core Admin Portal, as seen in Users &Devices | Users.

<blockReason>0</blockReason>

A bitmap value that lists the reasons, if any,that the device is blocked from accessing the
ActiveSync server. The possible values aredescribed in The possible values aredescribed in Compliance, quarantinedStatus,and blockReason values.

<clientId>1073741831</clientId>

For MOBILEIRON CORE internal use.

<compliance>0</compliance>

A bitmap value that lists the reasons, if any,

API Reference Document for MobileIron WebService| 19

Device Managementthat the device is out of compliance with its
security policy. The possible values aredescribed in Compliance, quarantinedStatus,and blockReason values.
<countryCode>1</countryCode>The country code for the device.

<details>

Device details, which consist of key-value
pairs. The set of key-value pairs vary by the
make, model, and operator of the device. The
set shown is only an example.

For more information, see Android Details
Key-Value Descriptions and iOS Details
Key-Value Descriptions.

If device registration is pending, then thedetails section is empty.
<entry><key>device_model</key><value>DROIDX</value></entry><entry><key>platform_name</key><value>2.2</value></entry><entry><key>Client_version</key><value>4.2.0</value></entry>

API Reference Document for MobileIron WebService| 20

Device Management</details><currentPhoneNumber>4085551212</currentPhoneNumber>

The phone number entered by the user oradministrator during registration.

<deviceCount>1</deviceCount>Not used. Always 0.

<emailAddress>jdoe@mobileiron.com</emailAddress>

The user’s email address as entered during
registration.

<employeeOwned>false</employeeOwned>true - the employee owns the device.
false - the enterprise owns the device.

The value is set during registration and theadministrator can change it.
<languageCountryId>0<languageCountryId>

The unique identifier for the country
associated with the language used on thedevice. For example, there would be adifferent ID for a Canadian French language
device when compared to a device from
France.

MobileIron Core assigns this identifier to thecountry.
<languageId>1</languageId>

The unique identifier for the language used on
the device.

<lastConnectedAt>2011-07-

The date and time that the device last made08T01:52:33+00:00</lastConnectedAt>

successful contact with the MobileIron
server.

For iOS devices that have iOS MDM
enabled, this value is the time of the last iOS
MDM checkin.
<manufacturer>Research In Motion</manufacturer>

The device manufacturer as automaticallyreported by the device during registration.

API Reference Document for MobileIron WebService| 21

Device Management<mdmManaged>false</mdmManaged>

Indicates that the MDM profile is enabled on
the device. This field applies only to iOS
devices. For other devices, the value isalways false.

<mdmProfileUrlId></mdmProfileUrlId>

MOBILEIRON CORE internal ID for its iOS
MDM profile information.

<model>8130</model>

The model of the device as reported by thedevice during registration.

<namejdoe:Android 4.4:PDA 2</name>

The concatenated name used to identify thedevice/user combination.

<notifyUser>true</notifyUser>true indicates the user should be notified via
email during registration. This does notcontrol whether MobileIron Core sends an
SMS message given a valid phone number,which it always does.

false indicates the user should not be
notified.

The notification consists of the principal
name, platform, and phone number.
<operator>PDA</operator>

Service provider for the device. The value
PDA indicates no operator is associated withthe device.

<operatorId>269</operatorId>

Identifier of the operator for the device.
MOBILEIRON CORE assigns this identifierto the operator.

<platform>Android 4.4</platform>

String indicating the platform installed on thedevice. The string is specified during
registration.

<quarantinedStatus>0<quarantinedStatus>

A bitmap value that lists the reasons, if any,that the device is quarantined. When adevice is quarantined, its configurations (that

API Reference Document for MobileIron WebService| 22

Device Management

is, profiles) have been removed due toviolations with its security policy.

The possible values are described inCompliance, quarantinedStatus, andblockReason values.
<regCount>0</regCount>

For Blackberry, after the MobileIron client isdownloaded, the VSP sends the provisioning
SMS message to the client. If the client fails
to connect, then the VSP resends themessage at a scheduled interval. This value
indicates how many times the VSP sent theprovisioning message to the client.

<regType>DEFAULT</regType>

This value applies only to BlackBerrydevices, indicating the registration typeconfigured on the VSP. Possible values are:
DEFAULT: Register/Deploy via MobileIron
BES: Register via MobileIron, Deploy via
BES
BESAUTO: Register/Deploy via BES 5.x.

<status>ACTIVE</status>

String indicating the current status of thedevice with regard to registration andconnection. For valid values, see Status
field above.

<statusCode>97</statusCode>Numeric code defined for the status. See listof valid values above.

<userDisplayName>Joe Doe</userDisplayName>

The concatenation of the user’s first nameand last name as defined during registration.

<userFirstName>Joe</userFirstName><userLastName>Doe</userLastName><userSource>76</userSource>

Value 76 for a local user.

API Reference Document for MobileIron WebService| 23

Device Management

Value 68 for an LDAP user.

Note:
76 is the value of ASCII ‘L’, which stands for
Local.
68 is the value of ASCII ‘D’, which stands for
Directory (LDAP).
<userUUID>de398fcb-a3a4-412c-a1dd-

Internal user ID.

9be8bd46e728</userUUID></device></deviceManagementWebServiceResponse>

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 MobileIron Core Admin Guide has more information about fields that are available in the Admin Portal.
Key Name

Key Description

Valueadmin_

Whether device administrator privilege is activated fortrue

activated

the MobileIron client on the device.
false

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

A name that the Android OS

device.

provides.

API Reference Document for MobileIron WebService| 24

Device Management

Key Name

Key Description

Value
Example: venus2

brand

The brand (e.g., carrier) the Android software is

A string that the Android OS

customized for, if any.

provides.
Example: verizon

c2dmToken

Android C2DM registration ID for the device.

A string of charactersclient_name

Name of MobileIron client application on the device.

Example: com.mobileironclient_MobileIron client version number running on the device.

Example: 4.5.0

Android platform’s current development codename, orExample: REL

versioncodename

the string "REL" if this is a release build.
country_

The device’s Mobile Country Codes (MCCs). MCCs

code

are defined in ITU E.212.

Example for United States: 310

current_

Phone number of the device

Example: 6505551212

Name of current registered operator.

Example: Verizon Wirelesscurrent_

International Mobile Subscriber Identity number for the

Example:SIM_device.

mobile_numbercurrent_
operator_
name262014530204577

module_numberdeviceThe name of the industrial design of the device.

A string that the Android OS
provides.
Examples:cdma_droid2
cdma_shadow

device_id

Unique identifier for the device

Example: ddc865b69c13eeb4

device_Manufacturer of the device.

Example: motorola

API Reference Document for MobileIron WebService| 25

Device Management

Key Name

Key Description

Value

Model of the Android device

Example: DROID2

Whether the device is roaming.

on – The device is roaming.

manufacturer
device_model
device_roaming_flag
off -- The device is not roaming.
device_type

Whether the device uses CDMA or GSM technology toCDMA or GSM

transmit voice calls. If the device does not transmit
voice calls, this fields whether the device uses CDMAor GSM technology is transmit data.
display_size

Size of the device’s display

Dimensions in pixels, in the format:<height>X<width>
Example: 854X480

free_media_

Amount of unused storage on the media card on the

card_size

device.

Number in bytes
Example: 2.36M

free_media_

Amount of unused storage on the media card on the

card_size_

device.
Example: 104857000

bytes

free_ram_

Number in bytes

Amount of RAM available on the device.

Number of megabytes, shown withsize

M suffix.
Example: 5.84M

free_ram_

Amount of unused RAM memory on the device.

Number in bytes.

size_bytes
Example: 104857000
free_

Amount of unused storage on the device

Number in bytes

storage_size
Example: 6489.68M
free_Size of unused storage on the device.

Number in bytes.

storage_

API Reference Document for MobileIron WebService| 26

Device Management

Key Name

Key Description

Valuesize_bytes
home_

Example: 104857000
Home service provider for the device

The service provider name, mobile

operatorcountry code and mobile networkcode 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

Example:device.
262018410218015
incremental

Android platform version’s build number.

Example: 110719

lat_long_

The last time the location of the device was recorded.

Specified as seconds since

last_

January 1, 1970.

captured_at
Example: 1324421860972
latitudeLatitude of the device’s location.

Degrees latitude.
Example: 37.396074

localeLocale for the device

Examples:en-US
enlongitude

Longitude of the device’s location.

Degrees longitude
Example: -122.056339

mdm_

Whether the MobileIron client is fully configured on thetrue – The MobileIron client is fully

enableddevice.

configured.

Note: The MobileIron client can be installed andfalse – The MobileIron client is notrunning, but still unable to manage the device if it is not

fully configured.

fully configured.

API Reference Document for MobileIron WebService| 27

Device Management

Key Name

Key Description

Value

multi_mdm

Whether multiple Device Admin applications are active

true – More than one Device Adminon the device.

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: 10
The value 10 corresponds toAndroid 2.3.3. Values are definedon http://developer.android.com.

platform_

Android platform version number on the device.

Example: 2.3.3

Processor architecture of the device.

armeabi-v7a

prv_

Whether the lockdown policy for the device has

ON – Access to Bluetooth isbluetoothdisabled access to Bluetooth.

enabled for both audio and data.

nameprocessor_
architecture

AUDIO – Access to Bluetooth isenabled for audio only.
OFF – Access to Bluetooth isdisabled.
unsupported – The MobileIron client
does not support enabling or
disabling Bluetooth on the device.
prv_camera

Whether the lockdown policy for the device has

ON – Access to the camera isdisabled access to the camera.

enabled.
OFF – Access to the camera isdisabled.
unsupported – The MobileIron client
does not support enabling or
disabling the camera on the device.

prv_device_

Whether the security policy for the device has enabledon – Device encryption is enabled.

API Reference Document for MobileIron WebService| 28

Device Management

Key Name

Key Description

Valueencryption

data encryption on the device.

off -- Device encryption is notenabled.
unsupported – The MobileIron client
does not support enabling or
disabling data encryption on thedevice.

prv_

Domain of the email server of the device’s user.

Email server domain.

exchange_
For example: MOBILEIRON

DomainIf the email client is not yet
configured, the value is na.
If the email client is not supported
by MobileIron, then the response
does not include this key-value pair.
prv_

Email server for the device’s user.

Email server address.

exchange_
For example: mail.mobileiron.com

Server

If the email client is not yet
configured, the value is na.
If the email client is not supported
by MobileIron, then the response
does not include this key-value pair.
prv_

Email user name of the device’s user.

Email user name.

exchange_
For example: jdoe@mobileiron.com

UserName

If the email client is not yet
configured, the value is na.
If the email client is not supported
by MobileIron, then the response
does not include this key-value pair.
prv_
exchange_

Whether email transport uses Secure Socket Layer.

ON – Email uses the Secure
Socket Layer. The value is ON if

API Reference Document for MobileIron WebService| 29

Device Management

Key Name

Key Description

Value

UseSSL

MobileIron 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 MobileIron, then the response
does not include this key-value pair.

prv_max_

Maximum number of times the user can enter an

The maximum number, or the value

failed_incorrect password before the device is wiped.

0 if no maximum exists.

attempts
This value is applicable only if prv_
password_type indicates that apassword is mandatory.
prv_max_

Maximum time the device can be inactive before theidle_timeuser must re-enter the password.

Number of minutes
Example: 30
This value is applicable only if prv_
password_type indicates that apassword is mandatory.

prv_
password

Whether both of the following conditions are true:
1. A password is mandatory for the user toaccess the device, as specified in the device’s
security policy.
2. The device is compliant with the security
policy.

ON – Both conditions are true.
OFF – One or both of the conditions
are not true.

prv_

Numbers of days after which the device’s password

The number of days, or the value

password_

will expire.

unsupported if a password is

expiration_

optional.

timeout
Example: 30
This value is applicable only if prv_
password_type indicates that apassword is mandatory.
prv_

Number of passwords remembered to ensure that the

A number, or the value unsupported

API Reference Document for MobileIron WebService| 30

Device Management

Key Name

Key Description

Value

password_

device’s user define a different password.

if a password is optional.

history_This value is applicable only if prv_

lengthpassword_type indicates that a
For example, the value 4 prevents the user frompassword is mandatory.

repeating a password for the next four password
changes.
prv_

Minimum length for the device’s password.

Number between 1 and 10, or -1

password_which indicates the password has

lengthno minimum length.
This value is applicable only if prv_
password_type indicates that apassword is mandatory.

prv_

Minimum number of special

A number or the value unsupported

password_

if no minimum is required.

minimum_characters that must be included in a password.

symbols

Applicable only to Android 3.0 and higher.

This value is applicable only if prv_
password_type indicates that apassword is mandatory.

prv_

Whether the device’s password is mandatory, and

0 – password is mandatory and is

password_

whether it must be restricted to simple numeric input,

restricted to alphanumerictypealphanumeric characters,

characters.

or has no restrictions. The security policy assigned to

1 – password is mandatory and is

the device specifies the password type.

restricted to simple numericcharacters.
2 – password is mandatory and has
no character restrictions.
-1 – password is optional.

prv_sd_Whether the security policy for the device has enabled

encryption

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 MobileIron client
does not support enabling or
disabling SD encryption on the

API Reference Document for MobileIron WebService| 31

Device Management

Key Name

Key Description

Value
device.

prv_sdcard

Whether the lockdown policy for the device has

ON – Access to the SD card isdisabled access to the SD card.

enabled.
OFF – Access to the SD card isdisabled.
unsupported – A lockdown policy is
not applied to this device.

prv_vpn_

A list of VPN servers that the device can access.

servers

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

ON – Access to wireless LANs is

disabled access to wireless LANs.

enabled.
OFF – Access to wireless LANs is
disabled.
unsupported – The MobileIron client
does not support enabling or
disabling access to wireless LANs
on the device.

prv_wlan_Wireless local area network Service Set Identifiers for

List of identifiers, separated byssids

all wireless LANs configures on the device.

semi-colons.
If none, then the value is na.
Example: MobileIronGuest;MobileIron-Testregistration_

International Mobile Subscriber Identity number for theimsidevice.

registration_

The name of the service provider for the device.

Example: 262073991646313

Example: Verizon

operator_
name

API Reference Document for MobileIron WebService| 32

Device Management

Key Name

Key Description

Value

regUuid

Device’s unique ID.

Example: ddc865b69c13eeb4

Samsung_

Samsung device information for Samsung devices that

Example:DMsupport Samsung MDM APIs.
FW: Key2,1 SW:1.0

security_

Indicates whether the device has been compromised.

Ok – The device has not beenstate

A compromised Android device means that the device

compromised.

has been rooted, which means that an application has
Compromised – The device hasroot access to the device’s file system.

been compromised.
SIM_

International Mobile Subscriber Identity number for themodule_device.

Example: IMSI:3104105000000000

numbersystem_id

CDMA System Identification number

Example: 40

total_media_

Amount of storage on the media card on the device.

Number of megabytes, shown with

card_size

M suffix.
Example: 7574.19M

total_media_

Amount of storage on the media card on the device.

Number in bytes

card_size_
Example: 785037745

bytes
total_ram_

Amount of RAM memory on the device.

size

Number of megabytes, shown with
M suffix.
Example: 475.93M

total_ram_

Amount of RAM memory on the device.

Number in bytes

size_bytes
Example: 504857000
total_
storage_size

Amount of storage on the device.

Number of megabytes, shown with
M suffix.
Example: 6700.98M

API Reference Document for MobileIron WebService| 33

Device Management

Key Name

Key Description

Value

total_

Amount of storage on the device.

Number in bytes

storage_
Example: 104857000

size_bytes
usb_

Indicates whether USB debugging is enabled on the

debugging

device.

ON – USB debugging is enabled.
OFF – USB debugging is disabled.

wifi_mac_

Wi-Fi MAC address of the device.

Example: f87b7a29838f

addr

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 MobileIron client provides. Key names without underscores, such asallowUntrustedTLSPrompt or maxGracePeriod, contain information that the device’s operating system provides.
Key Name

Key Description

Value

allowAppInstallation

Whether

Example: false

installation of
applications isallowed.

allowCloudBackup

Whethertrue – Backing up to iCloud is allowed.

backing up thedevice to iCloudfalse – Backing up to iCloud is not allowed.

is allowed.
Availability: iOS
5.0 and later.
allowCloudDocumentSync

When false,

Example: false

API Reference Document for MobileIron WebService| 34

Device Management

Key Name

Key Description

Value

document andkey-value
syncing toiCloud isdisabled.
allowExplicitContent

Whethertrue – Explicit content is not hidden.

explicit musicor video content

false – Explicit content is hidden.

purchased fromthe iTunes
Store is hidden.
Content ismarked as
explicit bycontent
providers whensold through the
iTunes Store.
allowInAppPurchases

Whether In-App

true – In-App Purchases are allowed.

purchases areallowiTunes

allowed.

false - In-App Purchases are not allowed.

Whether thetrue – iTunes is allowed.

iTunes MusicStore is allowed

false - iTunes is not allowed.

on the device.
allowMultiPlayerGaming

Whethertrue – Multiplayer gaming is allowed.

multiplayer
gaming isfalse - Multiplayer gaming is not allowed.

allowed.
allowPhotoStream

Indicates

true – Photo Stream is allowed.

whether thedevice’s Photofalse – Photo Stream is not allowed.

Stream isallowed on thedevice.

API Reference Document for MobileIron WebService| 35

Device Management

Key Name

Key Description

Value

Availability: iOS
5.0 and later.
allowUntrustedTLSPrompt

When false,true or false

automaticallyrejects
untrusted
HTTPS
certificateswithout
prompting theuser.

Availability: iOS
5.0 and later.
allowVideoConferencing

Whethertrue - Videoconferencing is allowed.

videoconferenci
ng is allowed on

false – Videoconferencing is not allowed.

the device.
allowVoiceDialing

Whether voicetrue – Voice dialing is allowed when the device is locked.

dialing isallowed whenfalse - Voice dialing is not allowed when the device is locked.

the device islocked.
allowYouTube

Whether thetrue - YouTube is allowed.

YouTubeapplication isfalse – YouTube is not allowed.

allowed on thedevice.
apnsToken

The device’s

Example:APNs (ApplePush

5c7b0866d6d068f8b4015690b83a6d1c00fb9484bdb00ea40d

Notification

926bbade28de5f

service) token.
AvailableDeviceCapacity

Floating-point

Example: 13.765106201171875

API Reference Document for MobileIron WebService| 36

Device Management

Key Name

Key Description

Valuegibibytes (base1024
gigabytes).
Battery Level

Floating-point

Example: 0.10000000149011612

percentage
expressed as avalue between
0.0 and 1.0, or 1.0 if battery
level cannot be
determined.

Availability: iOS
5.0 and later.
battery_life

PowerThe percentage of power remaining in the battery.

remaining in theBluetoothMAC

battery life.

Example: 30

Bluetooth MAC

Example: B8FF617F7927

address.
BuildVersion

The iOS build

Example: 8J3

number(8A260b, forexample).
CarrierSettingsVersion

Version of the

Example: 11.0

currentlyinstalled carrier
settings file.
CellularTechnology

Returns the

Example: GSM

type of cellular
technology.
Availability: iOS
4.2.6 and later.

API Reference Document for MobileIron WebService| 37

Device Management

Key Name

Key Description

Value

CheckOut Received

MobileIron Core

true – MobileIron Core has received a checkout message.

has received acheckout

false – MobileIron Core has not received a checkout

message frommessage.

the device. Thismessageindicates that
the MDM profile
was removed
from the device.
Client_build_date

Build date of the

Example: Apr 8 2011 12:02:24

MobileIron
client.
client_name

Name of

Example: com.mobileiron.phoneatwork

MobileIron
clientapplication on
the device.
Client_version

MobileIron

Example: 4.5.12.33698

client version
number runningon the device.
country_code

The device’s

Example for United States: 310

Mobile Country
Codes (MCCs).
MCCs aredefinedin ITU E.212 .
Current MCC

The device’s

Example for United States: 310

Mobile Country
Codes (MCCs).
MCCs are

API Reference Document for MobileIron WebService| 38

Device Management

Key Name

Key Description

Valuedefinedin ITU E.212 .
Current MNC

Current Mobile

Example: 00

Network Code.
If the device is
not roaming,
this is the sameas the SIM
MNC.
DataRoamingEnabled

Whether Data

Example: false

Roaming isenabled.
device_id

The

Example: IMEI:012537000804721

International
MobileEquipment
Number for an
iPhone.
device_manufacturer

DeviceExample: Apple

manufacturer.
For iOSdevices, thevalue is always
Apple.
device_model

Model of the

Examples:iOS device.
iPad
iPhone 4
device_type

Whether theCDMA or GSM

device uses
CDMA or GSM

Example: GSM

technology totransmit voice
calls. If thedevice does not

API Reference Document for MobileIron WebService| 39

Device Management

Key Name

Key Description

Valuetransmit voice
calls, this fieldindicates
whether thedevice uses
CDMA or GSM
technology totransmit data.
DeviceCapacity

Floating-point

Example: 14.020126342773438

gibibytes (base1024
gigabytes).
DeviceCompromised

Whether thetrue – The device is compromised.

device is

DeviceName

compromised.

false – The device is not compromised.

The name given

Example: Joe B’s iPadto the device
via iTunes.
forceEncryptedBackup

Whether thetrue or false

device forces
encrypted
backups.
free_storage_size_byte

Size of unused

Number in bytes.

storage on the

HardwareEncryptionCaps

device.

Example: 14780170240.000000000000000

Describes the

The value represents a bit field with following meanings:

underlying
hardwareencryption
capabilities ofthe device.

1 – block-level encryption
2 – file-level encryption
Therefore, because these are bit field values, the value 3means both block-level and file-level encryption.

API Reference Document for MobileIron WebService| 40

Device Management

Key Name

Key Description

Value

imei

The device’s

Example: 011981001429081

IMEI number.
Ignored if thedevice does notsupport GSM.
ImeiOrMeid

The device’s

Example: 01 198100 142908 1

MEID number.
Ignored if thedevice does notsupport CDMA.
imsi

International

The IMSI or the value na if the device has no IMSI.

MobileSubscriber

Example: 262073947704030

Identity number
for the device.
iOSBackgroundStatus

The status of

0 – The device supports background location multitasking,backgroundand the user has enabled location services.

location
multitasking on

1 – The device supports background location multitasking,the device.

but the user has disabled location services.
2 – Background multitasking has been disabled by theprivacy policy applied to the device.
3 – The device hardware does not support backgroundmultitasking.
4 – The iOS version is earlier than 4.0, and therefore does notsupport background multitasking.
Example: 3

ip_address

IP address of

Example: 192.168.1.174

the device.
The response includes this field only if the device hadconnected to a WIFI network. However, this field does notindicate whether the device is currently connected to a WIFI
network.

API Reference Document for MobileIron WebService| 41

Device Management

Key Name

Key Description

Value

iPhone ICCIDThe ICC

Example: 8949 2260 7349 2040 105

identifier for the
installed SIM
card.
iPhone IMEIInternational

Example: 01 253700 080472 1

MobileEquipment
Identity of thedevice.
iPhone MAC_ADDRESS_WIFI MAC

EN0

address of

Example: b8:ff:61:7f:79:26

device.
iPhone PRODUCTThe model code

Examples:for the device.
iPad
iPhone 4
iPhone UDID

The unique

Example: 81a3379d884f1bd9f1b0ce9b340358288081f7a1

device identifier(UDID) of the
iOS device.
iPhone VERSION

The iOS build

Example: 8J3

number of the
iOS version thatthe device isrunning.
it_policy_result

Not used.

Not used.

lat_long_last_captured_at

The last time

Specified as seconds since January 1, 1970.

the location of
the device was

Example: 1325108114776

recorded.
latitudeLatitude of theDegrees latitude.

device’slocation.

Example: 50.645397

API Reference Document for MobileIron WebService| 42

Device Management

Key Name

Key Description

Value

localeLocale for the

Examples:deviceen-US
enlongitude

Longitude of theDegrees longitude.

device’smaxGracePeriod

location.

Example: 7.943374

Maximum grace

Example: 900

period, inminutes, tounlock thephone without
entering apasscode. The
value 0 meansno grace period
is allowed; apasscode isrequired
immediately.
maxInactivity

Number of

Example: 300

minutes forwhich thedevice can beidle (without
being unlocked
by the user)
before it gets
locked by thesystem. Once
this limit isreached, thedevice is locked
and thepasscode must
be entered.

API Reference Document for MobileIron WebService| 43

Device Management

Key Name

Key Description

Value

minLength

Minimum

Example: 4

overall length ofthe passcode.
mobile_number

Phone number

The mobile number, or the value (null) if the device has noof the device.

mobile number.
Example:+491718169911

Model

The device’s

Examples:model number.
MC820LL
MC603DN
ModelName

Name of the

Examples:device model.
iPad
iPhoneModemFirmwareVersion

The baseband

Example: 05.16.05

firmwareversion.
os_version

The version of

Example:iOS that thedevice isrunning.
OSVersion

The version of

iPhone OS 4.3.3 (8J3)
iPhone OS 5.0.1 (9A405)
Example: 4.3.3

iOS that thedevice isrunning.
PasscodeIsCompliant

Set to true if thetrue or false

user'spasscode iscompliant withall

API Reference Document for MobileIron WebService| 44

Device Management

Key Name

Key Description

Valuerequirements on
the device,including
Exchange andother accounts.
PasscodeIsCompliantWith

Set to true if theProfilesuser'sExample: true

passcode iscompliant withrequirementsfrom profiles.
PasscodePresent

Set to true if thetrue or false

device isprotected by apasscode.
platform_name

For all iOS

Example: iPhone

devices, thisfield has thevalue iPhone.
platform_type

Either iPad or

Examples:iPhone.
iPad
iPhoneprocessor_architecture

For iOS

Example: ARM

devices, thevalue is always
ARM.
ProductName

The model code

Examples:for the device.
iPad1,1
iPhone3,1
ratingApps

Maximum rating

Example: 1000

for apps on thedevice,API Reference Document for MobileIron WebService| 45

Device Management

Key Name

Key Description

Valueaccording toApple’s ranking
of apps.
ratingMovies

Maximum rating

Example: 1000

for movies on
the device,according toApple’s ranking
of movies.
ratingTVShows

Maximum rating

Example: 1000

for TV showson the device,according toApple’s rankingof TV shows.
registration_imsi

International

Example: (null)

MobileSubscriber
Identity number
for the device.
registration_operator_

The name of thenameservice provider

safariAcceptCookies

The name of the service provider, or (null) if not applicable.

for the device.

Example: AT&T

Indicates

0 - Never

Safari’s setting
to accept
cookies.
safariAllowPopups

Indicates

1 - From visited
2 - Always
true – popups are allowed.

whether Safari
is set to allow

false – popups are not allowed.

pop-ups.

safariForceFraudWarning

Indicates

true – Fraud warning is enabled.

whether Safari

API Reference Document for MobileIron WebService| 46

Device Management

Key Name

Key Description

Valueis set to enablefalse – Fraud warning is not enabled.

fraud warning.

security_reason_code

Not used.

Not used.

security_state

Indicates

0 – The device has been compromised.

whether thedevice has

1 – The device has not been compromised.

been
compromised.
SerialNumber

The device’s

Example: V5046DGHZ38

serial number.
signal_strength

The signal

A number representing the signal strength, given in dBm.

strength on thedevice.
SIM MCC

Home Mobile

Example for United States: 310

Country Code(numeric
string). MCCs
are definedin ITU E.212 .
SIM MNC

The Mobile

Example:Network Codeof the SIM cardon the device.

01
07

Note: This fieldcontains anumeric MNC
only if the
network is
GSM. For
CDMA
networks, thisfield contains
an abbreviation

API Reference Document for MobileIron WebService| 47

Device Management

Key Name

Key Description

Valueof the carrier
name, such as
VZW or SPR,
for Verizon andSprint.
SIMCarrierNetwork

Name of the

Example: Telekom.dehome carrier
network.
Subscriber Carrier

Name of the

Networkhome carrier

Example: o2-de

network.
(Replaces
SIMCarrierNet
work.)

Availability: iOS
5.0 and later.
total_storage_size_bytes

Amount of

Number in bytes.

storage on the

Voice Roaming Enabled

device.

Example: 15053996032.000000536870912

Whether Voice

Example: true

Roaming isenabled.
WiFiMAC

Wi-Fi MAC

Example: B8FF617F7926

address.

Exporting Device Information to a CSV
To export device information to a CSV, use the following URI:
https://{host-name}/api/v1/dm/devices.csv
Note: No support is available for exporting device information for Exchange ActiveSync (EAS) devices to a CSV.
The request https://{host-name}/api/v1/eas/devices.csv is not supported.
The following fields are exported:

API Reference Document for MobileIron WebService| 48

Device Management

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

Operator
Country
Device UUID
Phone Number
Principal
Name
Platform
Manufacturer
Model
Email Address
Status Code
Employee Owned
Compliance
Quarantine Status
IMSI
IMEI
UDID
Client Version
MDM Enabled
Serial Number
Last Connected At
Active Sync UUID
Active Sync Last Sync Attempt
Wi-Fi MAC Address
Device Encryption
Last MDM Check-In
Last Security State Changed On
Registered On

Get Device Details for a Phone Number/User/Label/Wi-Fi MAC
Address
Device details such as manufacturer, model, OS, status, and registered email address can be retrieved in multiple
ways using an API. Search requests can be made by phone number, user ID, or label. A single user may be
assigned multiple devices, in which case a list of devices could be returned for a matching user ID. Given a phone
number in the request, the API returns the device details for the pairing of user and phone number. Given a label inthe request, the API returns the device details for all devices assigned to that label. The details returned depend on
what the device reports; different devices may return different information. This API applies only to registereddevices.
Examples:Get the device details for the device that has a specified phone number:
https://mycore.mobileiron.com/api/v1/dm/phones/4155551212

API Reference Document for MobileIron WebService| 49

Device Management

Get the device details for the devices that have the specified phone numbers:
https://mycore.mobileiron.com/api/v1/dm/phones/6505551212,4155551212

Get the device details for the devices belonging to the specified user:
https://mycore.mobileiron.com/api/v1/dm/users/jdoe

Get the device details for the devices assigned to a specific label:
https://mycore.mobileiron.com/api/v1/dm/labels/android

Get the device details for the device having a specific Wi-Fi MAC address:
https://mycore.mobileiron.com/api/v1/dm/devices/mac/38AA3C62BFAD

1. URI:

Device details of the input phone number ishttps://{host-name}/api/v1/dm/phones/{phone#}returned.

Http Method:

GET

Format:xml, json

Request:phoneNumber

Required.
This can be multiple, comma-separated phone
numbers. Example:
4085551212,6505551212

2. URI:

Device details of all devices registered to the input

https://{host-name}/api/v1/dm/users/{username}username will be returned.

Http Method:

GET

Format:xml, json

Request:userName

Required. Device unique login user name.

3. URI:

Device details of all devices assigned to the input

https://{host-name}/api/v1/dm/labels/{labelname}labelname will be returned.

Http Method:

GET

Format:xml, json

Request:API Reference Document for MobileIron WebService| 50

Device Management

labelName

Required. Unique label name.

4. URI:

Device details of the device associated with thehttps://{host-name}/api/v1/dm/devices/mac/

input Wi-Fi MAC address.

{macaddress}
Http Method:

GET

Format:xml, json

Request:
macAddress

Required.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><phoneNumber>14085551212</phoneNumber>Phone numbers fromthe request. Included in
response in these twocases:- only one phone
number was in therequest.
- the request specified
more than one phone
number, and a problem
occurred so that nodevice details areincluded in the
response.

API Reference Document for MobileIron WebService| 51

Device Management

Note: If the request
specified a user nameor a label name, they
are not repeated at the
beginning of the
response.
<messages><message>212 Device(s) returned</message>

Success is shown if the method execution is
successful.
A descriptive error message is shown if themethod execution failed.

Note: If the request specified one valid phone
number, the <messages> element is empty.
</messages><devices><device id=’2’>

Device identifier.

<uuid>8d711cdc-e93c-49b1-88d6-

Unique identifier for the device.

222f54132445</uuid><principal>jdoe</principal>

User ID for the user of the device. This
corresponds to the user ID in the Admin Portal, as
seen in Users & Devices | Users.

<blockReason>0</blockReason>

A bitmap value that lists the reasons, if any, thatthe device is blocked from accessing the
ActiveSync server. The possible values aredescribed in Compliance, quarantinedStatus, andblockReason values.

<clientId>1073741831</clientId>

For MOBILEIRON CORE internal use.

<compliance>0</compliance>

A bitmap value that lists the reasons, if any, thatthe device is out of compliance with its security
policy. The possible values are described inCompliance, quarantinedStatus, and blockReason

API Reference Document for MobileIron WebService| 52

Device Management

values.
<countryCode>1</countryCode>The country code for the device.

<countryId>183</countryId>

Country identifier for the device. MOBILEIRONCORE assigns this identifier to the country.

<countryName>United States</countryName><details>

Device details, which consist of key-value pairs.
The set of key-value pairs vary by the make,model, and operator of the device. The set shownis only an example.

For more information, see Android Details KeyValue Descriptions and iOS Details Key-Value
Descriptions.

If device registration is pending, then the details
section is empty.
<entry><key>total_ram_size</key><value>109.74M</value></entry><entry><entry><key>device_model</key><value>SGH-i617</value></entry><entry><key>platform_name</key><value>Windows Mobile 6.1

API Reference Document for MobileIron WebService| 53

Device Management

Standard</value></entry></details><deviceCount>0</deviceCount>Not used. Always 0.

<emailAddress>jdoe@mobileiron.com</emailAddress>

The user’s email address as entered during
registration.

<emailDomain>mydomain.com</emailDomain>

Not used at this time.

<employeeOwned>false</employeeOwned>true - the employee owns the device.
false - the enterprise owns the device.

The value is set during registration and theadministrator can change it.
<homeOperator>Verizon</homeOperator>

The service operator for the device when it is not
roaming.

<languageCountryId>183</languageCountryId>

The unique identifier for the country associatedwith the language used on the device. For
example, there would be a different ID for a
Canadian French language device when compared
to a device from France.

MobileIron Core assigns this identifier to thecountry.
<languageId>1</languageId>

The unique identifier for the language used on thedevice.

<lastConnectedAt>2011-07-

The date and time that the device last made08T01:52:33+00:00</lastConnectedAt>

successful contact with the MobileIron server.

For iOS devices that have iOS MDM enabled, thisvalue is the time of the last iOS MDM checkin.

API Reference Document for MobileIron WebService| 54

Device Management<manufacturer>Research In Motion</manufacturer>

The device manufacturer as automatically reportedby the device during registration.

<mdmManaged>false</mdmManaged>

Indicates that the MDM profile is enabled on thedevice. This field applies only to iOS devices. For
other devices, the value is always false.

<mdmProfileUrlId></mdmProfileUrlId>

MOBILEIRON CORE internal ID for its iOS MDM
profile information.

<model>8130</model>

The model of the device as automatically reportedby the device during registration.

<name>jdoe:Android 4.4:PDA 2</name>

The concatenated name used to identify thedevice/user combination.

<notifyUser>true</notifyUser>true indicates the user should be notified via email
during registration. This does not control whether
MobileIron Core sends an SMS message given a
valid phone number, which it always does.

false indicates the user should not be notified
during registration.

The notification consists of the principal name,platform, and phone number.

<operator>Verizon</operator>

Service provider for the device. The value PDA
indicates no operator is associated with thedevice.

<operatorId>4195</operatorId>

Identifier of the operator for the device.
MOBILEIRON CORE assigns this identifier to theoperator.

<phoneNumber>4085551212</phoneNumber>

The phone number entered by the user during
registration.

<platform>Android 4.4</platform>

String indicating the platform installed on thedevice. The string is specified during registration.

API Reference Document for MobileIron WebService| 55

Device Management<quarantinedStatus>0</quarantinedStatus>

A bitmap value that lists the reasons, if any, thatthe device is quarantined. When a device isquarantined, its configurations (that is, profiles)
have been removed due to violations with its
security policy.

The possible values are described in Compliance,
quarantinedStatus, and blockReason values.
<regCount>0</regCount>

For Blackberry, after the MobileIron client isdownloaded, the VSP sends the provisioning SMS
message to the client. If the client fails to connect,
then the VSP resends the message at a scheduledinterval. This value indicates how many times the
VSP sent the provisioning message to the client.

<regType>DEFAULT</regType>

This value applies only to BlackBerry devices,
indicating the registration type configured on the
VSP. Possible values are:
DEFAULT: Register/Deploy via MobileIron
BES: Register via MobileIron, Deploy via BES
BESAUTO: Register/Deploy via BES 5.x.

registeredAt

Lists the date and time of device registration.

<status>ACTIVE</status>

String indicating the current status of the device
with regard to registration and connection. See listof valid values above.

<statusCode>97</statusCode>Numeric code defined for the status. See list ofvalid values above.

<userDisplayName>Joe Doe</userDisplayName>

The concatenation of the user’s first name and last
name as defined during registration.

<userFirstName>Joe</userFirstName><userLastName>Doe</userLastName><userUUID>de398fcb-a3a4-412c-a1dd-

Internal user ID.

9be8bd46e728</userUUID>

API Reference Document for MobileIron WebService| 56

Device Management</device></devices></deviceManagementWebServiceResponse>

Register a Device
This API registers a device with MobileIron Core. Registering or enrolling a device designates it for management in
MobileIron Core. The action of registering a device accomplishes the following:••••

Activates a user associated with the device.
Makes the device known to the MobileIron system.
Downloads the MobileIron Client to the device
Completes an initial scan of the device and synchronizes it to MobileIron Core.

NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/register?phoneNumber=4155551212&userId=jdoe&platform=A&userFir
stName=Joe&userLastName=Doe&userEmailAddress=jdoe@mobileiron.com&notifyUser=True&notifyuserbysm
s=True&countrycode=1&operator=Verizon
Notice in the following example that if the deviceType is PDA, then the phoneNumber value can be PDA:
https://mycore.mobileiron.com/api/v1/dm/register?phoneNumber=PDA&deviceType=PDA&userId=miadmin&userFirstName=Jane&userLastName=Doe&userEmailAddress=jdoe@mi.com&countrycode=
33&importUserFromLdap=False&notifyUser=True&notifyuserbysms=True&platform=I

URI:

Register a device.

https://{host-name}/api/v1/dm/register/
Http Method:

PUT

Format:xml, json

Request:phoneNumber

Required for all device types
except for PDA. If the device
type is PDA, then you can

API Reference Document for MobileIron WebService| 57

Device Management

enter PDA as the phone
number value. This may
improve performance oversupplying a bogus phone
number.
userIdRequired.

operator

String indicating operator.
This field will be updated after
registration if MobileIron Corecan find the operator basedon the phoneNumber entry.

isEmployeeOwned

True indicates the device isowned by the employee.
False indicates it is owned by
the company. Default isfalse.

platform

Required. Platform or
operating system of thedevice.
Valid values:
A- Android
I – iOSE – Windows
M – Windows Phone devices(WP8, WP8.1)
L- Mac OS X

deviceType

Device type can be a phoneor PDA.
Valid values : Phone, PDA
If device is a PDA, thenphone number is optional and

API Reference Document for MobileIron WebService| 58

Device Management

you can enter PDA as thephone number value, too.
importUserFromLdap

True – import the matchinguser from LDAP.
False –create a local user.

If a local user does not exist
with the input userid, then a
new local user is created. For
local users, first name, last
name, and email address are
required.

MobileIron Core sets the
password for a new local user
to the userid.
userFirstName

Required for local user.
User’s first name.

userLastName

Required for local user.
User’s last name.

userEmailAddress

Required for local user.
User’s email address.

notifyUser

True indicates user should be
notified of registration byemail. False indicates user
should not be notified.

notifyuserbysms

True indicates user should be
notified of registration by
SMS. False indicates user
should not be notified by
SMS.

countryCode

Required. Country code of
the operator.

API Reference Document for MobileIron WebService| 59

Device Management

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Response:<deviceManagementWebServiceResponse><phoneNumber>14085551212</phoneNumber>Phone number registered.

<registration><messages/><deviceUuid>caba40e7-f56b-44aa-ac70-79e32e91adf8</deviceUuid>

Alpha-numeric string thatuniquely identifies the device.

<messages/>

Status Message.
Success is shown if themethod execution is
successful.
A descriptive error message
is shown if the method
execution failed.

<status>SUCCESS</status>

See “Status and statusCodevalues”.

<passcode>63460</passcode>

5-digit numeric passcodeneeded during registration
validation. If the passcode is
not applicable for theoperating system, it will be
empty.

<passcodeTTL>120</passcodeTTL>

Number of hours thepasscode is valid.

<registrationUrl>http://app16.mobileiron.com:8080/v/75b13</registrationUrl>

URL provided to the user.
User enters a passcode to

API Reference Document for MobileIron WebService| 60

Device Management

verify the device registrationand the client begins todownload.
</registration></deviceManagementWebServiceResponse>

Retire a Device
This API retires a device. Devices are retired based on a unique device ID (uuid).
NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/devices/retire/ee8198d9-5d79-4961-94c4e21bf04b2467?Reason=User%20replaced%20device
https://mycore.mobileiron.com/api/v1/dm/devices/retire/mac/38AA3C62BFAD?Reason=User%20repla
ced%20device

1. URI:

Device with the input device uuid is retired

https://{host-name}/api/v1/dm/devices/retire/{deviceuuid}
Http Method:

PUT

Format:xml, json

Request:Device uuid

Required. Unique ID of the device. This ID can be retrieved in
the response of other API calls, such as Device Registrationor Get Device Details.

ReasonFree form text field (512 character limit) to display reason why
the device is being retired.

2. URI:

Device with the input Wi-Fi MAC address is retired.

https://{hostname}/api/v1/dm/devices/retire/mac/{macaddress}

API Reference Document for MobileIron WebService| 61

Device Management

Http Method:

PUT

Format:xml, json

Request:
macAddress

Required.

ReasonFree form text field (512 character limit) to display reason why
the device is being retired.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><messages><message> Device is retired

Status Message.

successfully.</message>
Success is shown if the method execution is successful.
A descriptive error message is shown if the method execution
failed.
</messages><deviceUuid>caba40e7-f56b-44aa-ac70-

Unique device ID.

79e32e91adf8</deviceUuid></deviceManagementWebServiceResponse>

Lock a Device
This API locks a device, which typically forces the user to enter a passcode (either a user-generated or MobileIrongenerated password) to access the device and prevents the user from reversing this restriction. Devices arelocked based on unique device ID (uuid). As all mobile operating systems behave differently, refer to the
Administration Guide for details on lock support.

API Reference Document for MobileIron WebService| 62

Device Management

NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/devices/lock/ee8198d9-5d79-4961-94c4e21bf04b2467?Reason=User%20lost%20device
https://mycore.mobileiron.com/api/v1/dm/devices/lock/mac/38AA3C62BFAD?Reason=User%20lost%20
device1. URI:

Device with the input device uuid is locked.

https://{host-name}/api/v1/dm/devices/lock/{deviceuuid}
Http Method:

PUT

Format:xml, json

Request:Device UUID

Required. Unique ID of the device. This ID is sent in the
response of the Registration API.

ReasonRequired. Free form text field (512 character limit) to display
reason why the device is being locked.

1. URI:

Device with the Wi-Fi MAC address is locked.

https://{hostname}/api/v1/dm/devices/lock/mac/{macaddress}
Http Method:

PUT

Format:xml, json

Request:
macAddress

Required.

ReasonRequired. Free form text field (512 character limit) to display
reason why the device is being locked.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

API Reference Document for MobileIron WebService| 63Device Management

Response:<deviceManagementWebServiceResponse><messages><message>Device is locked

Status Message.

successfully.</message>
Success is shown if the method execution is successful.
A descriptive error message is shown if the method execution
failed.
</messages><deviceUuid>caba40e7-f56b-44aa-ac70-

Unique device ID.

79e32e91adf8</deviceUuid>

This field is not included for Android and iOS devices.
<unlockpasscode>12345</unlockpasscode>

Passcode to unlock the device. If this is missing, then thedevice was most likely locked with the user-set passcode.

This field is not included for Android and iOS devices.
< /deviceManagementWebServiceResponse>

Unlock a Device
This API unlocks a device.
On Android and iOS devices, unlocking the device clears its passcode.
On Blackberry devices, when a device without a user-generated passcode is locked, a special MobileIron
passcode must be generated and shared with the user to unlock the device. A special passcode may be generated
based on unique device ID (uuid). For those device, this API returns the unlock passcode.
Refer to the MobileIron Core Administration Guide for details on unlock support.

API Reference Document for MobileIron WebService| 64

Device Management

NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/devices/unlock/ee8198d9-5d79-4961-94c4e21bf04b2467?Reason=User%20forgot%20password
https://mycore.mobileiron.com/api/v1/dm/devices/unlock/mac/38AA3C62BFAD?Reason=User%20forgo
t%20password

1.URI:

Unlock passcode for the device with the input device uuid ishttps://{host-returned.

name}/api/v1/dm/devices/unlock/{deviceuuid}
Http Method:

GET

Format:xml, json

Request:Device UUID

Required. Unique ID of the device. This ID is sent in the
response of the Registration API.

ReasonRequired. Free form text field (512 character limit) to display
reason why the device is being unlocked.

2.URI:

Unlock passcode for the device with the input device Wi-Fi

https://{host-

MAC address is returned.

name}/api/v1/dm/devices/unlock/mac/{macaddress}
Http Method:

GET

Format:xml, json

Request:
macAddress

Required.

ReasonRequired. Free form text field (512 character limit) to display
reason why the device is being unlocked.

Response Status Code:‘404 – No Data Found’

There is no data.

API Reference Document for MobileIron WebService| 65

Device Management‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><messages><message>1 passcode(s) sent.</message>

Status Message.
Passcode count is shown if the method execution is
successful.
A descriptive error message is shown if the method execution
failed.

</messages><passcodes><passcode><uuid>cf667a65-1e1a-4121-af63-

Unique device ID.

398b11540d2f</uuid><name> jdoe:Android:6505551212</name>

Username:Platform: phonenumber string to help distinguishbetween a user’s multiple devices.

<value>6910</value>

For iOS devices:

Q – The device is MDM managed and has a passcode.
F – The device is MDM managed but has no passcode.
NA – The device is not MDM managed. Unlock is notpossible.

For Android devices:
Q – The device has a passcode.
F – The device has no passcode.

API Reference Document for MobileIron WebService| 66

Device Management

NA – Unlock failed.

For Blackberry devices:

Passcode to unlock the device. If value is empty, then thedevice was most likely locked with the user-set passcode.
</passcode></passcodes>< /deviceManagementWebServiceResponse>

Wipe a Device
This API wipes a device, which returns its settings to the factory defaults. Once wiped, device status changes to“Wiped,” and the only valid action to apply is Retire. A wipe call is based on a unique device ID (uuid).
You can use this API with ServiceNow.
Example:https://mycore.mobileiron.com/api/v1/dm/devices/wipe/ee8198d9-5d79-4961-94c4e21bf04b2467?Reason=Device%stolen
https://mycore.mobileiron.com/api/v1/dm/devices/wipe/38AA3C62BFAD?Reason= Device%stolen

1.URI:

Device with the input device uuid is wiped.

https://{host-name}/api/v1/dm/devices/wipe/{deviceuuid}
Http Method:

PUT

Format:xml, json

Request:Device UUID

Required. Unique ID of the device. This ID is sent in the
response of the Registration API.

ReasonFree form text field (512 character limit) to display reason

API Reference Document for MobileIron WebService| 67

Device Management

why the device is being wiped.

2.URI:

Device with the input device Wi-Fi MAC address is wiped.

https://{hostname}/api/v1/dm/devices/wipe/mac/{macaddress}
Http Method:

PUT

Format:xml, json

Request:
macAddress

Required.

ReasonFree form text field (512 character limit) to display reason
why the device is being wiped.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse><messages><message></message>

Status Message.
Success is shown if the method execution is successful.
A descriptive error message is shown if the method
execution failed.

</messages>

API Reference Document for MobileIron WebService| 68

Device Management<deviceUuid>caba40e7-f56b-44aa-ac70-

Unique device ID.

79e32e91adf8</deviceUuid>< /deviceManagementWebServiceResponse>

Wakeup Client
This API forces a device to connect to MobileIron Core, waking up the MobileIron Client. A wakeup call is basedon a unique device ID (uuid).
NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/devices/wakeup/ee8198d9-5d79-4961-94c4-e21bf04b2467
https://mycore.mobileiron.com/api/v1/dm/devices/wakeup/mac/38AA3C62BFAD

1.URI:

Request to wake up is sent to device withhttps://{host-name}/api/v1/dm/devices/wakeup/{deviceuuid}

the input device uuid.

Http Method:

GET

Format:xml, json

2.URI:

Request to wake up is sent to device withhttps://{host-name}/api/v1/dm/devices/wakeup/mac/

the input Wi-Fi MAC address.

{macaddress}
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response isreturned.

API Reference Document for MobileIron WebService| 69

Device Management

Response:< deviceManagementWebServiceResponse><messages><message>Wake up request sent to device with uuid:cf667a65-

Status Message.

1e1a-4121-af63-398b11540d2f</message>
Success is shown if the method execution
is successful.
A descriptive error message is shown if themethod execution failed.
</messages><deviceUuid>caba40e7-f56b-44aa-ac70-

Unique device ID.

79e32e91adf8</deviceUuid>< /deviceManagementWebServiceResponse>

Locate a Device
The MobileIron Client periodically records cell tower location information. When this API is used, the last known
location of the device is returned based on requested unique device ID (uuid). If needed, this API will remotely turnon a device’s GPS. To find the current location of the device:
1. Call this API with locatenow=true. This will send a request to the device to determine the current location. This
process might take between a few seconds and 1 minute.
2. Call the locate API again after a few minutes without the locatenow parameter . This will return the current
location found from step 1. If the current location could not be determined it will return the last known location.
NOTE: You can use this API with ServiceNow.
Examples:
https://mycore.mobileiron.com/api/v1/dm/devices/locate/ee8198d9-5d79-4961-94c4-e21bf04b2467
https://mycore.mobileiron.com/api/v1/dm/devices/locate/mac/38AA3C62BFAD
https://mycore.mobileiron.com/api/v1/dm/devices/locate/ee8198d9-5d79-4961-94c4e21bf04b2467?locatenow=true

API Reference Document for MobileIron WebService| 70

Device Management

1.URI:

Location of the device with the input device uuid is returned.

https://{hostname}/api/v1/dm/devices/locate/{deviceuuid}
Http Method:

GET

Format:xml, json

Request:Device UUID

Required. Unique ID of the device. This ID is sent in the
response of the Registration API.

locatenow

Optional. True or false. Defaults to false. See step 1 in the
explanation above. This parameter does not apply to iOS.

2.URI:

Location of the device with the input Wi-Fi MAC address ishttps://{host-returned.

name}/api/v1/dm/devices/locate/mac/{macaddress}
Http Method:

GET

Format:xml, json

Request:
macAddress

Required.

locatenow

Optional. True or false. Defaults to false. See step 1 in the
explanation above. This parameter does not apply to iOS.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse>

API Reference Document for MobileIron WebService| 71

Device Management<deviceUuid>cf667a65-1e1a-4121-af63-

Unique Device ID.

398b11540d2f</deviceUuid><messages><message></message>

Status Message.
Success is shown if the method execution is successful.
A descriptive error message is shown if the method execution
failed.

</messages><locations><location><uuid>cf667a65-1e1a-4121-af63-

Unique Device ID.

398b11540d2f</uuid><lookupResult>Cell</lookupResult>

Value returned describes how location was retrieved. Validvalues:LookupFailure: unable to retrieve the location of the device.
GPS: location retrieved using the GPS of the device.
Cell: location retrieved using cell towers.

<latitude>37.386433</latitude>

Latitude of the location of the device.

<longitude>-122.053902</longitude>

Longitude of the location of the device.

<radius>1500</radius><capturedAt>1285802663000</capturedAt>

Time when the location of the device was captured in epoch
format.

</location></locations><locateNow>false</locateNow></deviceManagementWebServiceResponse>

API Reference Document for MobileIron WebService| 72

Device Management

Enable Roaming
This API enables or disables voice and data roaming on an iOS 5 device. However, note the following:•••

Voice roaming is available only on certain carriers. If you use this API to enable voice roaming on a device, theAPI returns success regardless of whether voice roaming is available on that device’s carrier.
If you disable voice roaming, you are also disabling data roaming, even if you specify true (enable) for the dataroaming query parameter.
The API returns success regardless of whether the device supports the setting. To see whether a device has
data or voice roaming enabled, see the Voice Roaming Enabled and DataRoamingEnabled fields in the
response to a Get Device API. See iOS Details Key-Value Descriptions.

Example:https://mycore.mobileiron.com/api/v1/dm/devices/enableroaming/ee8198d9-5d79-4961-94c4e21bf04b2467?voice=true&data=false

URI:

The specified deviceuuid indicates the device

https://{host-name}/api/v1/dm/devices/enableroaming/on which to change roaming settings.

{deviceuuid}
Http Method:

PUT

Format:xml, json

Request:deviceuuid

Required. Unique ID of the iOS device. This
ID can be retrieved in the response of other
API calls, such as Get Devices by Status.

voice

Required. This parameter is a queryparameter.

Set to true to enable voice roaming.
Set to false to disable voice roaming.
data

Required. This parameter is a queryparameter.

Set to true to enable data roaming.
Set to false to disable data roaming.

API Reference Document for MobileIron WebService| 73

Device Management

If you set the voice parameter to false, dataroaming is disabled even if you set the data
parameter to true.
Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><deviceUuid>
190eb32e-32e1-4fe2-baa1-06a4488aaa4c</deviceUuid><messages><message>

Status message for voice roaming.

Device voice roaming settings updated successfully. The
voice roaming setting is available only on certain carriers.
Disabling voice roaming also disables data roaming.

Success is shown if the method execution is
successful.

</message>
A descriptive error message is shown if themethod execution failed.
<message>

Status message for data roaming.

Device data roaming settings updated successfully.
</message>

Success is shown if the method execution is
successful.
A descriptive error message is shown if themethod execution failed.

API Reference Document for MobileIron WebService| 74

Device Management</messages>< /deviceManagementWebServiceResponse>

Get all Labels
Using labels is the method by which devices are grouped in the MobileIron database. Labels can be used for
applying policies or performing other management tasks on multiple devices. An administrator can create labels in
addition to a default set supplied in MobileIron Core. This API lists all labels, whether or not they are in use.
Example:https://mycore.mobileiron.com/api/v1/dm/labels

URI:

All labels in the database are returned.

https://{host-name}/api/v1/dm/labels
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse ><messages><message>1 Label (s) returned</message>

Status message.
A label count is shown if the method execution is
successful.
A descriptive error message is shown if the method
execution failed.

API Reference Document for MobileIron WebService| 75

Device Management</messages><labels><label id=”-3”>

Internal database ID.
Negative numbers correspond to the default labels.
Positive numbers correspond to labels that MobileIron
Core administrator added.

<name>iOS</name>Label name.

<description>Label for all iOS

Label description.

devices.</description><staticLabel>false</staticLabel>

Static labels are system created labels.
False indicates a dynamic label. Devices which satisfy
the criteria specified in <searchCriteria> areautomatically added to this label.
True indicates a static label, which has no<searchCriteria> Devices are manually assigned tostatic labels.

<query>&quot;common.platform&quot;=&quot;iOS&quot;
AND&quot;common.retired&quot;=false</query><deviceCount>3</deviceCount>

The number of devices currently assigned to the label.

<isESSearch>116</isESSearch><label>API Reference Document for MobileIron WebService| 76

Device Management</labels>< /deviceManagementWebServiceResponse>

List of Operators
MobileIron retains a default list of operators for use during device registration. Operators may be enabled or
disabled by an administrator. This API returns a complete list of all operators, regardless of whether they are used.
Example:https://mycore.mobileiron.com/api/v1/dm/operators

URI:

All operators defined in database are returned.

https://{host-name}/api/v1/dm/operators
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse ><messages><message>1 Operator (s) returned</message>

Status message.
Operator count is shown if the method execution is
successful.
A descriptive error message is shown if the method
execution failed.

</messages>

API Reference Document for MobileIron WebService| 77

Device Management<operators><operator><carrierShortName>AT&amp;T</carrierShortName>

Operator name.

<carrierType>Mobile</carrierType>

Mobile: Operator provides mobile services.
Fixed: Operator provides fixed telecom services.

<countryCode>1</countryCode>Numeric country code.

<countryId>183</countryId>

Country identifier for the device. MOBILEIRONCORE assigns this identifier to the country.

<countryName>United States</countryName>Country name.

<enabled>true</enabled>

True indicates the operator is enabled (configured for
display) in the registration screen.
False indicates the operator is disabled.

<id>269</id>

Unique operator identifier in the database.

</operator></operators>< /deviceManagementWebServiceResponse>

List of Countries
MobileIron retains a default list of countries in the database. A country selection populates the country code field.
This API provides a complete list of all defined countries, regardless of whether they are used. This list of countries
is used during device registration.
Example:https://mycore.mobileiron.com/api/v1/dm/countries

API Reference Document for MobileIron WebService| 78

Device Management

URI:

All countries defined in the database are returned.

https://{host-name}/api/v1/dm/countries
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse ><messages><message>2 Countries returned</message>

Status Message.
Country count is shown if the method execution is
successful.
A descriptive error message is shown if themethod execution failed.

</messages><countries><country><countryName>United States</countryName>Country name.

<countryCode>1</countryCode>Numeric country code.

<isoAlpha2Code>US</isoAlpha2Code>ISO Alpha 2 country code.

<enabledForRegistration>102</enabledForRegistration>

Whether the MobileIron Core administrator
enabled the country for registration.
102 means disabled.
116 means enabled.

API Reference Document for MobileIron WebService| 79Device Management

Note: 116 is the ASCII value for ‘t’, which stands
for true, and 102 is the ASCII value for ‘f’, which
stands for false.
</country><country><countryName>India</countryName><countryCode>91</countryCode><isoAplha2Code>IN</isoAplha2Code><enabledForRegistration>116</enabledForRegistration></country></countries>< /deviceManagementWebServiceResponse>

Send Action to bulk devices
This request sends an action to multiple devices. The possible actions are:••••

Lock or unlock one or more devices.
Retire one or more devices.
Wipe one or more devices.
Wake up the MobileIron client on one or more devices, to force the clients to check in with MobileIron Core.

MobileIron Core validates that the request has a valid action and valid devices, and then sends the response.
MobileIron Core performs the actions after sending the response. You can view the actions taken by looking at
Logs & Events | All Logs in the Admin Portal.
If the requested action is invalid, MobileIron Core sends a response so indicating. If some devices are invalid, theresponse lists them, but MobileIron Core will still take the action on the valid devices.
Note: The UNLOCK bulk request is the exception. In this case, MobileIron Core performs the action before sending
the response.
Example:API Reference Document for MobileIron WebService| 80

Device Management

A LOCK request on two valid devices:
https://mycore.mobileiron.com/api/v1/dm/bulk/devices/LOCK?deviceUuids=1ac8bd81-4ab9-4e3eb3a8-0c4f70521d23&deviceUuids=ab7e93f4-90e2-485b-82b9-7a030ef7d985

The resulting response:<deviceManagementWebServiceResponse><messages/></deviceManagementWebServiceResponse>

URI:
https://{host-name}/api/v1/dm/bulk/devices/{actiontype}
Http Method:

POST

Format:xml, json

Request:actiontype

Required.
Specify one of these action types:
LOCK
UNLOCK
WAKEUP_DEVICERETIRE
WIPE

Note: These values are all capital letters.
deviceUuids

Required.

List each device uuid as a query parameter that has the namedeviceUuids. By default, the maximum number of device
uuids you can list is 20,000.

You can configure this value by setting the variablebulk.api.maxdeviceuuids in the file mifs.properties. This file islocated in the directory /mi/tomcat-properties in the LinuxAPI Reference Document for MobileIron WebService| 81

Device Management

system in which MobileIron Core is running.

Warning: The name of the parameter is deviceUuids, with an“s” at the end.
Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse><messages>

Status information, if any. Also specifies errors in the request,
if any.

If MobileIron Core has no status or errors to report, this field isempty.
<message>Invalid action</message>

If you do not capitalize the action or misspell it, this fieldcontains the value “Invalid action”.

<invalidDevices>

If the request contains one or more invalid device uuids, thisfield lists them.

<uuid> 1ac8bd81-4ab9-4e3e-b3a80c4f70521d23</uuid><uuid> 623094f9-645b-4ecf-884078597cc1254b</uuid></invalidDevices><passcodes>

Only for the UNLOCK action.

<passcode><uuid>1ac8bd81-4ab9-4e3e-b3a8-

The device uuid.

0c4f70521d23</uuid>
The concatenation of the device’s user’s name, device

API Reference Document for MobileIron WebService| 82

Device Management<name>jdoe:Android:6505551212</name><value>Q</value>

platform, and phone number.
For iOS devices:

Q – The device is MDM managed and has a passcode.
F – The device is MDM managed but has no passcode.

For Android devices:
Q – The device has a passcode.
F – The device has no passcode.

For Blackberry devices:

Passcode to unlock the device. If value is empty, then thedevice was most likely locked with the user-set passcode.
</passcode></passcodes><failedDevices>

Only for the UNLOCK action.

<message>
Message contents indicates the device for which the unlock
failed.
</message></failedDevices></deviceManagementWebServiceResponse>

Send message to devices
This request sends a message to one or more devices using email, SMS or push notification (e.g., APNS).
API Reference Document for MobileIron WebService| 83

Device Management

MobileIron Core validates that the request has valid devices, and then sends the response. MobileIron Core sends
the messages to the devices after sending the response. You can view the results of sending the messages bylooking at Logs & Events | All Logs in the Admin Portal.
If some devices are invalid, the response lists them, but MobileIron Core will still send the message to the valid
devices.
Examples:Send an SMS to two devices based on UDID.
https://app027.auto.mobileiron.com/api/v1/dm/bulk/sendmessage?mode=sms&message=Hello
World&deviceUuid=e6d4f5f0-d883-41d2-8e87-c76fb4ef4cde&deviceUuid=54bc5eb5-592c-472e-98d2e859bd037fef

The resulting response:<deviceManagementWebServiceResponse><messages/><message> Message sent successfully for all devices.</message></deviceManagementWebServiceResponse>

Send an SMS to a device based on Wi-Fi MAC address:
https://app027.auto.mobileiron.com/api/v1/dm/bulk/mac/sendmessage?mode=sms&message=Hello
World&deviceWiFiMacAddress=00237696635F

1.URI:
https://{hostname}/api/v1/dm/bulk/sendmessage
Http Method:

POST

Format:xml, json

Request:deviceUuid

Required.

List each device uuid as a query parameter that has the namedeviceUuid. By default, the maximum number of device uuids
you can list is 20,000.

You can configure this value by setting the variablebulk.api.maxdeviceuuids in the file mifs.properties. This file islocated in the directory /mi/tomcat-properties in the LinuxAPI Reference Document for MobileIron WebService| 84

Device Management

system in which MobileIron Core is running.

Warning: The name of this parameter is deviceUuid, with no“s” at the end.
message

Required.

subject

Valid only when the mode is email.

mode

Required. Possible values:
sms
email
pns (indicates push notification service)

2.URI:
https://{hostname}/api/v1/dm/bulk/mac/sendmessage
Http Method:

POST

Format:xml, json

Request:deviceWiFiMacAddress

Required.

List each Wi-Fi MAC address as a query parameter that has
the name macAddress.

message

Required.

subject

Valid only when the mode is email.

mode

Required. Possible values:
sms

API Reference Document for MobileIron WebService| 85

Device Management

email
pns

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:< deviceManagementWebServiceResponse><messages><message>Message sent successfully for

Status information.

all devices.</message></messages><invalidDevices>

If the request contains one or more invalid device uuids, thisfield lists them.

<uuid> 1ac8bd81-4ab9-4e3e-b3a80c4f70521d23</uuid><uuid> 623094f9-645b-4ecf-884078597cc1254b</uuid></invalidDevices></messageSentFailed>

Indicates the message was not sent for at least one specified
device, due to, for example, an invalid device uuid.

</deviceManagementWebServiceResponse>

Get Profiles for a Device
This API returns the configurations and policies for a specified device uuid.
Example:https://app027.auto.mobileiron.com/api/v1/dm/devices/profiles/e6d4f5f0-d883-41d2-8e87c76fb4ef4cde
API Reference Document for MobileIron WebService| 86Device Management

URI:

All profiles applied to the specified device are returned.

https://{host-name}/api/v1/dm/devices/profiles/{deviceUuid}

Http Method:

GET

Format:xml, json

Request:deviceUuid

Required.
Unique ID of the device. This ID can be retrieved in the
response of other API calls, such as Device
Registration or Get Device Details.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<deviceManagementWebServiceResponse><messages /><profiles><profile id="-7"><uuid>misystem-default-docs-policy</uuid><name>Default Docs@Work Policy</name><policyType>DOCS</policyType>API Reference Document for MobileIron WebService| 87Device Management<status>Applied</status><profileType>POLICY</profileType><lastUpdatedAt>1347343156739</lastUpdatedAt></profile><profile id="-3"><uuid>misystem-default-security-policy</uuid><name>Default Security Policy</name><policyType>SECURITY</policyType><status>Applied</status><profileType>POLICY</profileType><lastUpdatedAt>1347343165503</lastUpdatedAt></profile><profile id="-2"><uuid>misystem-default-privacy-policy</uuid><name>Default Privacy Policy</name><policyType>PRIVACY</policyType><status>Applied</status><profileType>POLICY</profileType><lastUpdatedAt>1347343156731</lastUpdatedAt></profile><profile id="-2"><name> System - iOS MDM</name><policyType>MDM</policyType><status>Applied</status><profileType>APP</profileType>API Reference Document for MobileIron WebService| 88Device Management<lastUpdatedAt>1347343165501</lastUpdatedAt></profile></profiles></deviceManagementWebServiceResponse>

Re-push Profiles for a Device
This API re-pushes the specified configuration or policy for the device uuid.
Example:https://app027.auto.mobileiron.com/api/v1/dm/devices/repushprofile/e6d4f5f0-d883-41d2-8e87c76fb4ef4cde
https://app386.auto.mobileiron.com/api/v1/dm/devices/repushprofile/1faaaf43-c99d-4c21-bab4c9e810bd9606?id=3&type=APP

URI:All profiles applied to the specified device are returned.

https://{hostname}/api/v1/dm/devices/repushprofile/{deviceUuid}

Http Method:

PUT

Format:xml, json

Request:deviceUuid

Required.
Unique ID of the device. This ID can be retrieved in the response ofother API calls, such as Device Registration or Get Device
Details.

id

Profile ID. Use the Get Profiles API to get the profile ID.

type

APP for configuration
POLICY for policy

API Reference Document for MobileIron WebService| 89Device Management

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:

API Reference Document for MobileIron WebService| 90

7Exchange ActiveSync (EAS)
List All ActiveSync Devices
This API returns a list of ActiveSync unique device IDs (uuid) that use ActiveSync to connect to the enterprise.
Devices are grouped as follows in the return list: Registered Allowed, Registered Blocked, Unregistered Allowed,
Unregistered Blocked, and Wiped.
An administrator may wish to block an ActiveSync device to prevent it from connecting to the enterprise (i.e., getemail). If a device is blocked, any previously synchronized email is removed. Use the allow feature to permit adevice to connect to the enterprise which was previously blocked.
Example:https://mycore.mobileiron.com/api/v1/eas/devices

URI:

All ActiveSync devices are returned.

https://{host-name}/api/v1/eas/devices
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<easWebServiceReponse><messages><message>212 Device(s) returned</message>

Status message. Lists the number of devices found, orthat no devices were found.

</messages><registeredAllowedDevices><registeredAllowedDevice>

All the child elements of the

API Reference Document for MobileIron WebService| 91

Exchange ActiveSync (EAS)<registeredAllowedDevice> element are also
in the <registeredBlockedDevice>,<unregisteredAllowedDevice>,<unregisteredBlockedDevice>, and<wipedDevice> elements.
<uuid>hdgd-e93c-49b1-88d6-

ActiveSync unique identifier for the device.

222f54132445</uuid><domain>exchdomain.com</domain>

The Exchange ActiveSync domain of thedevice.

<deviceId>Appl87025CNUA4S</deviceId>

ActiveSync device identifier.

<mailboxId>jdoe113</mailboxId>

ActiveSync mailbox ID for the device.

<userName>jdoe113</username>

ActiveSync username associated with thedevice.

<phoneNumber>6505551212</phoneNumber>Phone number associated with the device.

<model>iPhone</model>

Device model as recorded by the ActiveSync
server.

<platform>iOS</platform>

Device operating system as recorded by the
ActiveSync server.

<platformCode>11</platformCode>Device operating system code as recorded by
te ActiveSync server.

<status>Registered</status>

MobileIron status for the device.

<activeSyncStatus>Allowed</activeSyncStatus>

ActiveSync status for the device.

<firstSyncTime>1326179585000</firstSyncTime>The timestamp for the first time the device
synchronized ActiveSync data. This time field
is expressed in Unix Epoch Time, which isthe number of milliseconds since January 1,
1970.

<lastSyncTime>1326180768000</lastSyncTime>The timestamp for te last time the device
synchronized ActiveSync data. This time field
is expressed in Unix Epoch Time, which isthe number of milliseconds since January 1,
1970.

API Reference Document for MobileIron WebService| 92

Exchange ActiveSync (EAS)<miDeviceUuid>6f72cabb-1d8b-4965-aa8e-

MobileIron unique identifier for the device.

a355deab8222</miDeviceUuid><actionSource>EXCHANGE</actionSource></registeredAllowedDevice>

ActiveSync unique identifier for a registereddevice with Allowed status.

</registeredAllowedDevices>

A list of ActiveSync unique identifiers forregistered devices with Allowed status.

<registeredBlockedDevices>

A list of ActiveSync unique identifiers forregistered devices with Blocked status.

<registeredBlockedDevice><uuid>hgdgd-fsg-4wfsb1-dgdg-dgfdg</uuid>

ActiveSync unique identifier for a registereddevice with Blocked status.

</ registeredBlockedDevice ></ registeredBlockedDevices><unregisteredAllowedDevices>

A list of ActiveSync unique identifiers forunregistered devices with Allowed status.

<unregisteredAllowedDevice><uuid>8herw5345d711cdc-e93c-dfg-hgdf-

ActiveSync unique identifier for an

hssgfd</uuid>

unregistered device with Allowed status.

</ unregisteredAllowedDevice ></ unregisteredAllowedDevices><unregisteredBlockedDevices>

A list of ActiveSync unique identifiers forunregistered devices with Blocked status.

<unregisteredBlockedDevice><uuid>34gdrtger-4err-gd-88d6-2fes</uuid>

ActiveSync unique identifier for an
unregistered device with Blocked status.

</ unregisteredBlockedDevice ></ unregisteredBlockedDevices><wipedDevices>

A list of ActiveSync unique identifiers for

API Reference Document for MobileIron WebService| 93

Exchange ActiveSync (EAS)

devices that have been wiped via ActiveSync
wipe.
< wipedDevice ><uuid>sersdfsc-e93c-49b1-88d6-

ActiveSync unique identifier for a wiped

sg2wefwef</uuid>device.

</ wipedDevice ></ wipedDevices ></easWebServiceReponse>

Device Details for ActiveSync
This API returns a variety of details for devices using ActiveSync to connect to the Enterprise. Details ranging
from the first time such device was synced to the ActiveSync version are returned.
Example:https://mycore.mobileiron.com/api/v1/eas/devices/ee8198d9-5d79-4961-94c4-e21bf04b2467

URI:

Device details of the input

https://{host-name}/api/v1/eas/devices/{EASDeviceUuid}

Exchange ActiveSync device
uuid is returned

Http Method:

GET

Format:xml, json

Request:
EASDeviceUuid

Required. Exchange ActiveSync
device uuid.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the responseis returned.

API Reference Document for MobileIron WebService| 94

Exchange ActiveSync (EAS)

Response:<easDevice><uuid>f5def24e-4380-4565-bd2f-8cf002fd64cd</uuid><details>

A series of key/value pairs
determined by ActiveSync.

<entry><key>ActionSource</key>

EXCHANGE('e', "Exchange"):
Initial state set by the Exchange
server.
AUTOBLOCK('a', "Auto"): state
set by Auto Block action
POLICY('p', "Policy"): state set
by policy enforcement
MANUAL('m', "Manual"): state
set manually by administrator
UNKNOWN('u', "Unknown")<value>Exchange</value></entry><entry><key>LastPingHeartbeat</key><value>600</value></entry><entry><key>DeviceID</key><value>Appl9C0180RF75J</value></entry><entry><key>FirstSyncTime</key>

API Reference Document for MobileIron WebService| 95

Exchange ActiveSync (EAS)<value>7/6/2010 11:29:33 AM</value></entry><entry><key>DevicePolicyApplicationStatus</key><value>AppliedInFull</value></entry><entry><key>LastSyncAttemptTime</key><value>7/7/2010 12:14:52 PM</value></entry><entry><key>NumberOfFoldersSynced</key><value>2</value></entry><entry><key>DeviceType</key><value>iPod</value></entry><entry><key>DeviceModel</key><value>iPod</value></entry><entry><key>DeviceUserAgent</key><value>Apple-iPod/705.18</value>

API Reference Document for MobileIron WebService| 96

Exchange ActiveSync (EAS)</entry><entry><key>Status</key><value>DeviceOk</value></entry><entry><key>Guid</key><value>61a8a847-8e3b-4496-8da6-587b845b77cf</value></entry><entry><key>DeviceAccessState</key><value>Allowed</value></entry><entry><key>DeviceEnableOutboundSMS</key><value>False</value></entry><entry><key>Identity</key><value>newyork.mobileiron.com/Users/Sang
Truong/ExchangeActiveSyncDevices/iPod§Appl9C0180RF75J</value></entry><entry><key>DeviceAccessStateReason</key><value>Individual</value></entry>

API Reference Document for MobileIron WebService| 97

Exchange ActiveSync (EAS)<entry><key>DevicePolicyApplied</key><value>Default</value></entry><entry><key>LastPolicyUpdateTime</key><value>7/6/2010 11:29:34 AM</value></entry><entry><key>IsRemoteWipeSupported</key><value>True</value></entry><entry><key>LastSuccessSync</key><value>7/7/2010 12:14:52 PM</value></entry><entry><key>RecoveryPassword</key><value>********</value></entry><entry><key>DeviceActiveSyncVersion</key><value>12.1</value></entry></details></easDevice>

API Reference Document for MobileIron WebService| 98

Exchange ActiveSync (EAS)

Request Action on ActiveSync Device
This API requests status changes to devices using ActiveSync to connect to the Enterprise.
Example:https://mycore.mobileiron.com/api/v1/eas/devices?action=BLOCK_DEVICE&uuids=ee8198d9-5d794961-94c4-e21bf04b2467&uuids=fe816c9-4c68-3850-83b3-d10ae93a1356

URI:

The requested action will be applied on the device.

https://{host-name}/api/v1/eas/devices
Http Method:

PUT

Format:xml, json

Request:uuids

Required.
One or more Exchange ActiveSync device uuids.

actionRequired.
Valid Actions are:
BLOCK_DEVICE: Block the device from accessing ActiveSync
server.
REINSTATE_DEVICE: Allow the device to access ActiveSync
server.
WIPE: Wipe the device, which returns its settings to the factory
defaults.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<easWebServiceResponse><messages><message>1 device(s) modified to BLOCK_DEVICE

Status message. Displays action taken on EAS device.

API Reference Document for MobileIron WebService| 99

Exchange ActiveSync (EAS)

status</ message ></messages></easWebServiceResponse>

API Reference Document for MobileIron WebService| 100

8Security Management
The Security Management API addresses authentication tasks. These tasks apply to both local users and LDAP
users.

Update Password for a User
This API changes the password for a single user.
Example:https://mycore.mobileiron.com/api/v1/sm/authentication/users/jdoe
For security reasons, include the old and new passwords in the HTTP request body rather thanas query parameters. For example:
PUT /api/v1/sm/authentication/users/jdoe HTTP/1.1
Host: mycore.mobileiron.com
Content-Length: 44
Accept: application/json
Authorization: Basic amRvZTphYmNkMTIzNA==
Content-Type: application/x-www-form-urlencoded
oldpassword=abcd1234&newpassword=wxy!13579

URI:

Updates password for input username.

https://{hostname}/api/v1/sm/authentication/users/{username}Http Method:

PUT

Format:xml, json

Request:username

Required.

Unique login user name.
oldpassword

Current password of the user.

Note: For security reasons, include this parameter in HTTP
request body.

API Reference Document for MobileIron WebService| 101

Security Management

Required only if the MobileIron Core setting to save theuser password is set to Yes. You can set this value in the
Admin Portal, using Settings | Preferences.

When oldpassword is required, make sure that the value
you provide in the request is correct. If it is not included or is
not correct, the response contains a failure message.

Note: When you create a local user using the API to
Register a Device, MobileIron Core sets the user’s
password to the user ID (called username in this request).
newpassword

Required.

New password of the user.

The password must be between 8 and 20 characters.

Note: For security reasons, include this parameter in HTTP
request body.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<securityManagementWebServiceResponse><userName>jdoe</userName>API Reference Document for MobileIron WebService| 102

Security Management<messages><message>
Password changed successfully for user: jdoe

Status Message.
Success shown if the method execution is successful.
A descriptive error message is shown if the method
execution failed.

</ message ></messages></securityManagementWebServiceResponse>

Find a User
This API finds a single user by username or email address. User details will be returned only if the search finds anexact match of the username or email address.
Example:https://mycore.mobileiron.com/api/v1/sm/users/jdoe

URI:

Finds the user specified forhttps://{host-name}/api/v1/sm/users/{username}input username or email
address

Http Method:

GET

Format:xml, json

Request:Response Status Code:‘404 – No Data Found’

There is no data.

API Reference Document for MobileIron WebService| 103

Security Management‘200 – OK’

Data is present and the
response is returned.

Response:<securityManagementWebServiceResponse><userName>miadmin</userName><messages/><user id="9001"><uuid>f89d8cbf-59d7-47e6-97c2-4681ed8f954a</uuid><principal>miadmin</principal><createdAt>1374085200000</createdAt><displayName>miadmin</displayName><email>miadmin@mobileiron.com</email><enabled>true</enabled><firstName>miadmin</firstName><forcePasswordChange>false</forcePasswordChange><googleAppsEncryptionAlgVersion>0</googleAppsEncryptionAlgVersion><lastAdminPortalLoginTime>1374178220915</lastAdminPortalLoginTime><lastName></lastName><opaque>true</opaque><roles>ROLE_MPW_LOCK</roles><roles>ROLE_USER_MANAGEMENT_RW</roles><roles>ROLE_MAI_RW</roles><roles>ROLE_APPS_AND_FILES_RW</roles>

API Reference Document for MobileIron WebService| 104

Security Management<roles>ROLE_SENTRY_FOR_IPAD</roles><roles>ROLE_ADMIN_LOCATE</roles><roles>ROLE_LOG_R</roles><roles>ROLE_TROUBLESHOOTING_RW</roles><roles>ROLE_EVENT_CENTER_RW</roles><roles>ROLE_ADMIN_WIPE</roles><roles>ROLE_SELECTIVE_WIPE</roles><roles>ROLE_MPW_REG</roles><roles>ROLE_SECURITY_AND_POLICIES_RW</roles><roles>ROLE_MPW_LOCATE</roles><roles>ROLE_API</roles><roles>ROLE_SMARTPHONES_AND_DEVICES_RW</roles><roles>ROLE_MPW_WIPE</roles><roles>ROLE_USER_PORTAL_RW</roles><roles>ROLE_CONNECTOR</roles><roles>ROLE_SETTINGS_RW</roles><userSource>76</userSource></user></securityManagementWebServiceResponse>

Search LDAP Users
This API finds users by username. The search string cannot be less than 2 characters. If the search results are
more than the search limit (can be configured in mifs.properties) an error is returned. Default search limit is 100.
Example:https://mycore.mobileiron.com/api/v1/sm/users/search/ldap/?userid=jdoe

API Reference Document for MobileIron WebService| 105

Security Management

URI:

Finds the users for the specified username

https://{host-name}/api/v1/sm/users/search/ldap/{userid}

search string.

Http Method:

GET

Format:xml, json

Request:useridRequired.
Username search string. Minimum 2 characters.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

API Reference Document for MobileIron WebService| 106

Security Management‘400- Bad Request’

1. If the input search string is less than 2characters.
2. If the search results are more than the limit.

Response:<securityManagementWebServiceResponse><userName>testuser000</userName><messages/><users><user><principal>testuser0001</principal><displayName>testuser0001</displayName><email>testuser0001@auto1.mobileiron.com</email><enabled>false</enabled><firstName>Test</firstName><forcePasswordChange>false</forcePasswordChange><lastName>User0001</lastName><opaque>true</opaque><userSource>68</userSource></user><user><principal>testuser0003</principal><displayName>testuser0003</displayName>API Reference Document for MobileIron WebService| 107

Security Management<email>testuser0003@auto1.mobileiron.com</email><enabled>false</enabled><firstName>Test</firstName><forcePasswordChange>false</forcePasswordChange><lastName>User0003</lastName><opaque>true</opaque><userSource>68</userSource></user></users></securityManagementWebServiceResponse>

Authenticate a User
This API authenticates a single user by username.
Example:https://mycore.mobileiron.com/api/v1/sm/authentication

For security reasons, include the password in the HTTP request body rather than as a query parameter. For
example:POST /api/v1/sm/authentication HTTP/1.1
Host: mycore.mobileiron.com
Content-Length: 31
Accept: application/json
Authorization: Basic amRvZTphYmNkMTIzNA==
username=jdoe&password=abcd1234

URI:

Finds the user specified forhttps://{host-name}/api/v1/sm/users/{username}input username.

Http Method:

POST

Format:xml, json

API Reference Document for MobileIron WebService| 108

Security Management

Request:username

StringRequiredNote: For security reasons,
include this parameter in HTTP
request body.
Password

StringRequired
The password must be
between 8 and 20 characters.
Note: For security reasons,
include this parameter in HTTP
request body.

Response Status Code:‘401 – Unauthorized’

If the username/password isinvalid.

API Reference Document for MobileIron WebService| 109

Security Management‘200 – OK’

If username and password are
valid then User details are
returned in the response.

Response:<securityManagementWebServiceResponse><userName>miadmin</userName><messages/><user id="9001"><uuid>f89d8cbf-59d7-47e6-97c2-4681ed8f954a</uuid><principal>miadmin</principal><createdAt>1374085200000</createdAt><displayName>miadmin</displayName><email>miadmin@mobileiron.com</email><enabled>true</enabled><firstName>miadmin</firstName><forcePasswordChange>false</forcePasswordChange><googleAppsEncryptionAlgVersion>0</googleAppsEncryptionAlgVersion><lastAdminPortalLoginTime>1374178220915</lastAdminPortalLoginTime><lastName></lastName><opaque>true</opaque><roles>ROLE_MPW_LOCK</roles><roles>ROLE_USER_MANAGEMENT_RW</roles><roles>ROLE_MAI_RW</roles>

API Reference Document for MobileIron WebService| 110

Security Management<roles>ROLE_APPS_AND_FILES_RW</roles><roles>ROLE_SENTRY_FOR_IPAD</roles><roles>ROLE_ADMIN_LOCATE</roles><roles>ROLE_LOG_R</roles><roles>ROLE_TROUBLESHOOTING_RW</roles><roles>ROLE_EVENT_CENTER_RW</roles><roles>ROLE_ADMIN_WIPE</roles><roles>ROLE_SELECTIVE_WIPE</roles><roles>ROLE_MPW_REG</roles><roles>ROLE_SECURITY_AND_POLICIES_RW</roles><roles>ROLE_MPW_LOCATE</roles><roles>ROLE_API</roles><roles>ROLE_SMARTPHONES_AND_DEVICES_RW</roles><roles>ROLE_MPW_WIPE</roles><roles>ROLE_USER_PORTAL_RW</roles><roles>ROLE_CONNECTOR</roles><roles>ROLE_SETTINGS_RW</roles><userSource>76</userSource></user></securityManagementWebServiceResponse>

API Reference Document for MobileIron WebService| 111

9AlertsMobileIron’s Event Center enables administrators to connect events to specific alerts. The following events arerecognized:
•
•
•
•
•
•

International Roaming Event
Threshold Reached Event
SIM Changed Event
Storage Size Exceeded Event
System Event
Policy Violations Event

This API can retrieve alerts generated by an above named event.
Alerts include a variety of characteristics, such as severity, lifecycle status, and read/unread status. Alert
Lifecycle statuses are defined as follows:
1. Created: the conditions for generating the alert have been met.
2. Processed: the alert has been generated.
3. Dispatched: the alert has been sent.
- Dispatch Pending: alert is ready for dispatch.
- Dispatching: dispatch is in progress.
- Dispatched: dispatch has been completed successfully.
- Dispatch Failed: dispatch failed.

Get All Alerts
This API returns all alerts. You can filter the alerts by their read/unread status.
Examples:Get all alerts:
https://mycore.mobileiron.com/api/v1/alerts
Get all alerts that have not been read:
https://mycore.mobileiron.com/api/v1/alerts?isRead=false

API Reference Document for MobileIron WebService| 112

Alerts

URI:

Returns list of all alerts.

https://{host-name}/api/v1/alerts
Http Method:

GET

Format:xml, json

Request:isReadFilter by the read status of thealert.
True returns all alerts that aremarked read.
False returns all the alerts thatare marked unread.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Response:<alertWebServiceResponse><messages><message>1 alert(s) returned</message>

Status Message.
Alert count is shown if themethod execution is
successful.
A descriptive error message isshown if the method execution
failed.

</messages><alerts><alert id=”5”>

Internal database ID uniquely

API Reference Document for MobileIron WebService| 113

Alerts

identifies alert.
<deviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</deviceUuid><dispatchDeviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</dispatchDeviceUuid><userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>

uuid of the user.

<labelId>163</labelId>

The internal id of the label thattriggered the alert.
.

<eventSubscriptionName>m1</eventSubscriptionName><alertDate>2010-05-01T01:02:00+00:00</alertDate><alertText>WARNING::Memory size exceeded 1% for Phone #:Alert content.

14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory
Size: 133.59MB</alertText><isActive>false</isActive>

true -- the alert is unread.

false -- the alert is read.
<retries>2</retries>

Number of attempts that havebeen made to send this alert.

<updateBy>alertprocessor</updateBy>

Name of user/systemcomponent which updated thisalert.

<updatedAt>2010-04-30T01:04:00+00:00</updatedAt>

The time at which this alert
record was last modified.

<userName>miadmin</userName>

Recipient user name.

<alertDefnname>MEMORY_SIZE_EXCEEDED_

Alert type:

ALERT</alertDefnname>

INTERNATIONAL_
ROAMING_ALERTAPI Reference Document for MobileIron WebService| 114

Alerts

THRESHOLD_REACHED_ALERTSIM_CHANGED_ALERTMEMORY_SIZE_
EXCEEDED_ALERTSYSTEM_ALERTPOLICY_VIOLATIONS_
ALERT<severity>WARNING</severity>

Alert severity:
INFORMATIONWARNINGCRITICAL<transport>EMAIL</transport>

Means by which alert iscommunicated:
EMAIL
SMS
APNS (iPhone only)<status>DISPATCHED</status>

Alert dispatch status:
CREATEDPROCESSEDDISPATCH_PENDINGDISPATCHINGDISPATCHEDDISPATCH_FAILED<isAlertRead>true</isAlertRead>

Not used. The isActive fieldindicates whether the alert isread or unread.

API Reference Document for MobileIron WebService| 115

Alerts</alert></alerts></alertWebServiceResponse>

Get All Alerts for Phone NumberThis API returns all alerts for a single device phone number. You can further filter the alerts by their read/unread
status.
The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts islimited to alerts for the phone number specified in the request.
Examples:Get all alerts for a phone number:
https://mycore.mobileiron.com/api/v1/alerts/phones/6505551212

Get all alerts for a phone number that have been read:
https://mycore.mobileiron.com/api/v1/alerts/phones/6505551212?isRead=true

URI:

Returns list of all alerts forhttps://{host-name}/api/v1/alerts/phones/{phonenumber}

input phone number.

Http Method:

GET

Format:xml, json

Request:phoneNumber

Required. Phone number.

isReadFilter by the read status of thealert.
True returns all alerts which aremarked read.
False returns all the alerts
which are marked unread.

Response Status Code:API Reference Document for MobileIron WebService| 116

Alerts‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Response:<alertWebServiceResponse><messages><message>1 alert(s) returned</message>

Status Message.
Alert count is shown if themethod execution is
successful.
A descriptive error message isshown if the method execution
failed.

</messages><alerts><alert><id>5</id><deviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</deviceUuid><dispatchDeviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</dispatchDeviceUuid><userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>

uuid of the user.

<labelId>1</labelId>

The internal id of the label thattriggered the alert.

<eventSubscriptionName>m1</eventSubscriptionName><alertDate>2010-05-01T01:02:00+00:00</alertDate><alertText>WARNING::Memory size exceeded 1% for Phone #:Alert content.

14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory

API Reference Document for MobileIron WebService| 117

Alerts

Size: 133.59MB</alertText><isActive>false</isActive>

true -- the alert is unread.

false -- the alert is read.
<retries>0</retries>

The number of attempts thathave been made to send thisalert.

<updateBy>alertprocessor</updateBy><updatedAt>2010-04-30T01:04:00+00:00</updatedAt><userName>miadmin</userName>

Recipient user name.

<alertDefnname>MEMORY_SIZE_EXCEEDED_

Alert type.

ALERT</alertDefnname><severity>WARNING</severity>

Alert severity:
INFORMATIONWARNINGCRITICAL<transport>EMAIL</transport>

Means by which alert iscommunicated:
EMAIL
SMS
APNS (iPhone only)<status>DISPATCHED</status>

Alert dispatch status (asdescribed in the Alerts section
above):
CREATEDPROCESSEDDISPATCH_PENDINGDISPATCHING

API Reference Document for MobileIron WebService| 118

Alerts

DISPATCHEDDISPATCH_FAILED<isAlertRead>true</isAlertRead>

Not used. The isActive fieldindicates whether the alert isread or unread.

</alert></alerts></alertWebServiceResponse>

Get all Alerts for User
This API returns all alerts for a single user. Because users may have multiple devices, this API returns all alerts on
all devices matching the username. You can further filter the alerts by their read/unread status.
The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts islimited to alerts for the user specified in the request.
Examples:Get all alerts for a user:
https://mycore.mobileiron.com/api/v1/alerts/users/jdoe

Get all unread alerts for a user:
https://mycore.mobileiron.com/api/v1/alerts/users/jdoe?isRead=false

URI:

Returns list of all alerts for the

https://{host-name}/api/v1/alerts/users/{username}input user name.

Http Method:

GET

Format:xml, json

Request:Username

Required. Unique login user
name.

isReadFilter by the read status of thealert.

API Reference Document for MobileIron WebService| 119

Alerts

True returns all alerts which aremarked read.
False returns all the alerts
which are marked unread.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Response:<alertWebServiceResponse><messages><message>1 alert(s) returned</message>

Status Message.
Alert count is shown if themethod execution is
successful.
A descriptive error message isshown if the method execution
failed.

</messages><alerts><alert><id>5</id><deviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</deviceUuid><dispatchDeviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</dispatchDeviceUuid><userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>

uuid of the user.

<labelId>1</labelId>

The internal id of the label that

API Reference Document for MobileIron WebService| 120

Alerts

triggered the alert.
<eventSubscriptionName>m1</eventSubscriptionName><alertDate>2010-05-01T01:02:00+00:00</alertDate><alertText>WARNING::Memory size exceeded 1% for Phone #:Alert content.

14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory
Size: 133.59MB</alertText><isActive>false</isActive>

true -- the alert is unread.

false -- the alert is read.
<retries>2</retries>

Number of attempts that havebeen made to send this alert.

<updateBy>alertprocessor</updateBy><updatedAt>2010-04-30T01:04:00+00:00</updatedAt><userName>miadmin</userName>

Recipient user name.

<alertDefnname>MEMORY_SIZE_EXCEEDED_

Alert type.

ALERT</alertDefnname><severity>WARNING</severity>

Alert severity:
INFORMATIONWARNINGCRITICAL<transport>EMAIL</transport>

Means by which alert iscommunicated:
EMAIL
SMS
APNS (iPhone only)<status>DISPATCHED</status>

Alert dispatch status:
CREATED

API Reference Document for MobileIron WebService| 121

Alerts

PROCESSEDDISPATCH_PENDINGDISPATCHINGDISPATCHEDDISPATCH_FAILED<isAlertRead>true</isAlertRead>

Not used. The isActive fieldindicates whether the alert isread or unread.

</alert></alerts></alertWebServiceResponse>

Get All Alerts for a Phone Number of a User
This API returns all alerts for a single phone number of a user. You can further filter the alerts by their read/unread
status.
The fields in the response are the same as the fields in the Get All Alerts Response. However, the set of alerts islimited to alerts for the user specified in the request.
Example:https://mycore.mobileiron.com/api/v1/alerts/users/jdoe/phones/16505551212

URI:

Returns list of all alerts for the

https://{host-name}/api/v1/alerts/users/{username}/phones/{phonenumber}

input phone number of the input
user name.

Http Method:

GET

Format:xml, json

Request:Username

Required. Unique login username.

phoneNumber

Required. Phone number.

isReadFilter by the read status of the

API Reference Document for MobileIron WebService| 122

Alerts

alert.
True returns all alerts which aremarked read.
False returns all the alerts
which are marked unread.

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Response:<alertWebServiceResponse><messages><message>1 alert(s) returned</message>

Status Message.
Alert count is shown if themethod execution is
successful.
A descriptive error message isshown if the method execution
failed.

</messages><alerts><alert><id>5</id><deviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</deviceUuid><dispatchDeviceUuid>6482dce2-ea75-400a-9f2cd67766d942cf</dispatchDeviceUuid>

API Reference Document for MobileIron WebService| 123

Alerts<userUuid>asdasd-34sd-234sdf-sfsdfd</userUuid>

uuid of the user.

<labelId>1</labelId>

The internal id of the label thattriggered the alert.

<eventSubscriptionName>m1</eventSubscriptionName><alertDate>2010-05-01T01:02:00+00:00</alertDate><alertText>WARNING::Memory size exceeded 1% for Phone #:Alert content.

14085551212 (miadmin), Total Memory Size: 154.86MB, Free Memory
Size: 133.59MB</alertText><isActive>false</isActive>

true -- the alert is unread.

false -- the alert is read.
<retries>2</retries>

Number of attempts that havebeen made to send this alert.

<updateBy>alertprocessor</updateBy><updatedAt>2010-04-30T01:04:00+00:00</updatedAt><userName>miadmin</userName>

Recipient user name.

<alertDefnname>MEMORY_SIZE_EXCEEDED_

Alert type.

ALERT</alertDefnname><severity>WARNING</severity>

Alert severity:
INFORMATIONWARNINGCRITICAL<transport>EMAIL</transport>

Means by which alert iscommunicated:
EMAIL
SMS
APNS (iPhone only)

API Reference Document for MobileIron WebService| 124

Alerts<status>DISPATCHED</status>

Alert dispatch status:
CREATEDPROCESSEDDISPATCH_PENDINGDISPATCHINGDISPATCHEDDISPATCH_FAILED<isAlertRead>true</isAlertRead>

Not used. The isActive fieldindicates whether the alert isread or unread.

</alert></alerts></alertWebServiceResponse>

Update Alert
This API updates the read/unread status and comments to a particular alert.
Example:https://mycore.mobileiron.com/api/v1/alerts/ 3936?isRead=false&comments=Reset

URI:

Updates the alert designated by the alert ID.

https://{host-name}/api/v1/alerts/{id}Http Method:

PUT

Format:xml, json

Request:Id

Required. Alert ID to be updated.

isReadRequired.
True updates the alert as read.
False updates the alert as unread.

API Reference Document for MobileIron WebService| 125

Alerts

Comments

Required.
Comments to be added to the alert. Free form text field(255 character limit).

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<alertWebServiceResponse><messages><message>Updated alert 3936

Status Message.

successfully</message>
Success is shown if the method execution is successful.
A descriptive error message is shown if the method
execution failed.
</messages></alertWebServiceResponse>

Update List of Alerts
This API updates the read/unread status and comments to multiple alerts, designated by a list of IDs.
Example:https://mycore.mobileiron.com/api/v1/alerts?id=3936&id=3934&isRead=true&comments=”Jdoe readthis alert”

URI:

Updates multiple alerts, designated by alert IDs.

https://{host-name}/api/v1/alerts/
Http Method:

PUT

Format:xml, json

Request:API Reference Document for MobileIron WebService| 126

Alertsid

Required. Alert IDs to be updated.
Note: The IDs are query parameters.
For example:
https://{host-name}/api/v1/alerts?id=1&id=2&id3
Three alerts with ids= 1, 2 and 3 are updated with the specified
isRead value and comments value.

isReadRequired.
True updates the alert as read.
False updates the alert as unread.

Comments

Required.
Comments to be added to the alert. Free form text field (255character limit).

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<alertWebServiceResponse><messages><message> Updated 10 alert(s)Status Message.

successfully</message>
Alert update count is shown if the method execution is
successful.
A descriptive error message is shown if the method execution
failed.
</messages></alertWebServiceResponse>

API Reference Document for MobileIron WebService| 127

10

Policies
Get Policies
This API returns the list of all polices across all devices in the MobileIron system.
Example:https://mycore.mobileiron.com/api/v1/policies

URI:

Returns list of all policies installed across all devices.

https://{host-name}/api/v1/policies
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<policyWebServiceResponse><messages><message> 1 policy

Status Message.

returned.</message>
Policy count is shown if the method execution is successful.
A descriptive error message is shown if the method execution
failed.
</messages><policies><policy id="-2"><policyName>Default Privacy

Policy name.

Policy</policyName>API Reference Document for MobileIron WebService| 128

Policies

Policy Type. Either DEFAULT or ENTERPRISE.
<policyType>DEFAULT</policyType>
Profile type. Either PRIVACY, SECURITY, LOCKDOWN, or<profileType>PRIVACY</profileType>SYNC.

<status>Active</status>

Active or Inactive.

<active>true</active>

Whether the policy is active.
true means Active.
false means Inactive.
Deprecated.

<defaultPolicy>false</defaultPolicy><description>Default Privacy

Policy description.

Policy</description>
Number of devices for which the policy is applied.
<deviceCount>1</deviceCount>
Number of devices for which the policy is pending.
<pendingCount>1</pendingCount><priority>1</priority>

Priority<rules>

Policy rules, which consist of type-value pairs. The set of typevalue pairs are listed in Section Policy Rules Policy Rules.

The rule shown here is only an example.
<rule><type>PRIVACY_SYNC_

Rule type

CALLLOGS</type><value>store</value><clientValue>off</clientValue></rule>API Reference Document for MobileIron WebService| 129

Policies….
<rules></policy></policies></ policyWebServiceResponse >Get Policies by DeviceUUIDThis API returns the list of all polices by device uuid in the MobileIron system.
Example:https://mycore.mobileiron.com/api/v1/policies/devices/027d9439-0f75-4d30-8d7d-120b4cb8646b

URI:

Returns list of all policies by device uuid.

https://{hostname}/api/v1/policies/devices/{deviceuuid}
Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Response:<policyWebServiceResponse><messages><message> 1 policy

Status Message.

returned.</message>
Policy count is shown if the method execution is successful.
A descriptive error message is shown if the method execution
failed.

API Reference Document for MobileIron WebService| 130

Policies</messages><policies><policy id="-2"><policyName>Default Privacy

Policy name.

Policy</policyName>
Policy Type. Either DEFAULT or ENTERPRISE.
<policyType>DEFAULT</policyType>
Profile type. Either PRIVACY, SECURITY, LOCKDOWN, or<profileType>PRIVACY</profileType>SYNC.

<status>Active</status>

Active or Inactive.

<active>true</active>

Whether the policy is active.
true means Active.
false means Inactive.

<defaultPolicy>false</defaultPolicy><description>Default Privacy

Deprecated.
Policy description.

Policy</description>
This field is not applicable for this request.
<deviceCount>0</deviceCount>
This field is not applicable for this request.
<pendingCount>0</pendingCount><priority>1</priority>

Priority<rules>

Policy rules, which consist of type-value pairs. The set of typevalue pairs are listed in Section Policy Rules Policy Rules.

The rule shown here is only an example.
<rule><type>PRIVACY_SYNC_

Rule type

CALLLOGS</type>

API Reference Document for MobileIron WebService| 131

Policies<value>store</value><clientValue>off</clientValue></rule>….
<rules></policy></policies></ policyWebServiceResponse >Apply/Remove policy for a label.
This API applies a policy to a label or removes a policy from a label.
Example:https://mycore.mobileiron.com/api/v1/policies/-2?action=apply_label&label=Testlabel

URI:

Returns status.

https://{hostname}/api/v1/policies/{policyid}
Http Method:

PUT

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Request:policyid

Required. The internally generated policy ID. Use the Get Policies and Get
Policies by DeviceUUID to determine a policy’s ID.

actionRequired. This parameter is a query parameter.

API Reference Document for MobileIron WebService| 132

Policies“apply_label” – to apply the label to the policy“remove_label” – to remove the label from the policy
label

Required. Label name.

This parameter is a query parameter.
Response:<policyWebServiceResponse><messages><message>
Policy applied to label

Status Message.
A descriptive error message is shown if the method execution failed.

Android successfully.
</message></messages><policyWebServiceResponse>

Policy Rules
An HTTP response that contains information about a policy includes a <rules> element made up of many <rule>elements.
For example:<rules><rule><type>SYNC_HEARTBEAT_INTERVAL</type><value>14</value><clientValue>840</clientValue></rule><rule><type>SYNC_MULTITASK_INTERVAL</type><value>15</value><clientValue>15</clientValue></rule></rules>

The following tables show the values of these <type> elements, their meanings, and possible values.

API Reference Document for MobileIron WebService| 133

Policies

Note: The <clientValue> element is deprecated. Ignore its values.

Security policy rules
The following table shows the rules for security policies, listed alphabetically by the name of the <type> field.
Note: Not all the security rules apply to all device types.
For information about security policies, see the MobileIron® Administration Guide.
Security policy

Description

ValuesEAS_BLOCK_

Whether to take an action when data

Value: true or false

ANDROID_

encryption is disabled on an Android

DATA_ENC

device.

ClientValue: deprecated.

EAS_BLOCK_

Whether to take an action when

Value: true or false

ANDROID_

MobileIron detects that the device

DEVICE_

administrator privilege has been removed

ADMIN_

from the MobileIron app.

rule <type> field

ClientValue: deprecated.

DEACTIVE
EAS_BLOCK_The version of Android below which

ANDROID_OS

MobileIron takes an action.

Value: An Android version number.
For example: 2.3
ClientValue: deprecated.

EAS_BLOCK_

Whether to take an action when

Value: true or false

ANDROID_

MobileIron detects an Android device

ROOTEDthat has been rooted.

ClientValue: deprecated.

EAS_BLOCK_

Whether to take an action when

Value: true or false

IOS_DEVICE_

MobileIron detects that the MDM profileMDM_

has been removed from an iOS device.

ClientValue: deprecated.

EAS_BLOCK_

Whether to take an action when data

Value: true or false

IPHONE_

encryption is disabled on an iOS device.

DEACTIVE

ClientValue: deprecated.

DATA_ENC

EAS_BLOCK_

Whether to take an action for particular

IPHONE_HW

iOS device models that the administrator

Value:API Reference Document for MobileIron WebService| 134

Policies

Security policy

Description

Valueshas specified as disallowed.

false – No devices are disallowed.

rule <type> field

Disallowed devices are specified in a commaseparated list of numbers. The numbers are:1 – iPhone, original version
2 – iPhone 3G
3 – iPhone 3GS
4 – iPod touch, 1st gen
5 – iPod touch, 2nd gen
6 – iPod touch, 3rd gen
7 – iPad
16 – iPhone 4
18 – iPod touch, 4th gen
22 – iPad 2
28 – iPhone 4s
ClientValue: deprecated.
EAS_BLOCK_

Whether an iOS device has been

IPHONE_

compromised (jailbroken).

Value:
true – the device has been compromised.

JAILBROKEN

false – the device has not been compromised.
ClientValue: deprecated.
EAS_BLOCK_The iOS version below which MobileIron

IPHONE_OS

takes an action.

Value: An iOS version number.
Example: 3.0
ClientValue: deprecated.

EAS_BLOCK_The number of days a device cannot

Value: A number.

API Reference Document for MobileIron WebService| 135

Policies

Security policy

Description

Valuesconnect to MobileIron before MobileIron

ClientValue: deprecated.

rule <type> field
OOC_DAYS

takes an action.
EAS_BLOCK_The specified number of days after which

POLICY_DAYSMobileIron takes an action when it
detects that a device has not met policy

Value: A number.
ClientValue: deprecated.

requirements.

SEC_NCA_The action to take when data encryption

ANDROID_is disabled on an Android device.

Value:
0 – No action.

DATA_ENC

1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when the device

ANDROID_administrator is removed from an Android

DEVICE_

device.

ADMIN_
DEACTIVE

Value:
0 – No action.
1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created the

API Reference Document for MobileIron WebService| 136

Policies

Security policy

Description

Valuesrule <type> fieldaction.
ClientValue: deprecated.
SEC_NCA_The action to take when an Android

ANDROID_

device that has

Value:
0 – No action.

ROOTED
been “rooted,” that is, root access has
been given to an app. A rooted Android
device is also called compromised.

1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.

SEC_NCA_The action to take when the version of

ANDROID_SW

Android on a device is less than aspecified version.

Value:
0 – No action.
1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.

SEC_NCA_The action to take when a device has

APP_violated app control rules.

Value:API Reference Document for MobileIron WebService| 137

Policies

Security policy

Description

Valuesrule <type> field
CONTROLNo value – No action.
1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.

SEC_NCA_The action to take when data encryption

IOS_DATA_

is disabled on an iOS device.

Value:
0 – No action.

ENC

1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when an iOS device is

IOS_HW

disallowed.

Value:
0 – No action.

See EAS_BLOCK_IPHONE_HW for thelist of disallowed devices.

1 – Send alert.
2 – Block ActiveSync and send alert.

API Reference Document for MobileIron WebService| 138

Policies

Security policy

Description

Valuesrule <type> field
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when an iOS device

IOS_

has been compromised (jailbroken).

Value:
0 – No action.

JAILBROKEN

1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when MobileIron

IOS_MDM_

detects that the MDM profile has been

DEACTIVE

removed from an iOS device.

Value:
0 – No action.
1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the

API Reference Document for MobileIron WebService| 139

Policies

Security policy

Description

Valuesrule <type> field
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when the iOS version

IOS_SWis below a specified level.

Value:
0 – No action.
1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive numbers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned anumber to the action when the MobileIron
Core administrator created the action.
ClientValue: deprecated.

SEC_NCA_The action to take when the device has

OOC_DAYS

not connected to MobileIron in a

Value:
0 – No action.

specified number of days.

1 – Send alert.
2 – Block ActiveSync and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SEC_NCA_The action to take when MobileIron

Value:POLICY_DAYS

detects that a device has not met policy

API Reference Document for MobileIron WebService| 140

Policies

Security policy

Description

Valuesrequirements for the specified number of

0 – No action.

rule <type> fielddays.
1 – Send alert.
2 – Block ActiveSynch and send alert.
Other positive integers – Corresponds to acompliance action the MobileIron Coreadministrator created to disable or quarantine
the device. MobileIron Core assigned an
integer value to the action when the
MobileIron Core administrator created theaction.
ClientValue: deprecated.
SECURITY_

Whether to run anti-virus scanning on the

AV_BLOCK_

files of the device.

Value: off
ClientValue: deprecated.

DEVICES

Applicable only to Blackberry devices.
SECURITY_

A list of App Control Rules of type

A comma-separated list of numbers that

BLACK_

Allowed or Disallowed that are enabled incorrespond to App Control Rules. MobileIron

WHITE_BMW_

the security policy. The type AllowedCore assigned a number to the App Control

ACLS(white-listed) or Disallowed (black-listed)

Rule when the MobileIron Core administratoris specified by the value of SECURITY_

created the rule. The list can be empty.

BLACK_WHITE_BMW_OPTION.
For example:
3
3,6
ClientValue: deprecated.
SECURITY_

Whether App Control Rules listed in

BLACK_

SECURITY_BLACK_WHITE_BMW_

Value:WHITE_BMW_

ACLS are of type Allowed (white-listed)

WHITE – the App Control Rules are of type

OPTIONor Disallowed (black-listed).

Allowed.

API Reference Document for MobileIron WebService| 141

Policies

Security policy

Description

Valuesrule <type> field
BLACK – the App Control Rules are of type
Disallowed.
ClientValue: deprecated.
SECURITY_

Whether the policy requires data

Contains a <resourceDTOs> element for

ENCRYPT_

encryption for each of these data types:

each data type.

DATA_TYPE

Email, PIM, and documents.
<resourceDTOs><name>PIM</name><resourceType>PIM</resourceType><value>on</value></resourceDTOs>

Possible values for <name> and<resourceType>: Email, PIM, MY_
DOCUMENTS.

Possible values for <value>: on, off.
SECURITY_

Whether the security policy requires

ENCRYPT_

device encryption.

Value:
on – Device encryption is required.

DEVICE

off – Device encryption is not required.
ClientValue: deprecated.
SECURITY_

Specifies which file types require data

A <resourceDTOs> element is specified for

ENCRYPT_

encryption. The possible file types areeach of .doc, .xls, .pdf, .txt. and media files.

FILE_TYPE.doc, .xls, .pdf, .txt, media files, andothers specified by the administrator.

The <name> and <resourceType> fieldvalues of each <resourceDTOs> element iseither doc, xls, pdf, txt, MEDIA_FILES, or
OTHER_FILE_TYPES.

API Reference Document for MobileIron WebService| 142

Policies

Security policy

Description

Valuesrule <type> field
The <value> field of each <resourceDTOs>
element except OTHER_FILE_TYPES iseither on or off.
The <value> field of each the OTHER_FILE_
TYPE <resourceDTOs> element is a spaceseparated list of other file types.
ClientValue: deprecated.
SECURITY_

Whether SD card encryption is required

ENCRYPT_on the device.

Value:
on – SD card encryption required.

SDCARD

off – SD card encryption not required.
ClientValue: deprecated.
SECURITY_

The period of time during which the user

GRACE_is still able to enter the correct password

PERIOD

after the device has been locked.

Value: The number of minutes.
ClientValue: deprecated.
Note that this field is applicable only if thepassword is mandatory, the maximum
inactivity timeout is 0, and the device is an
iOS device.

SECURITY_

The maximum amount of time

Value:

to allow as an inactivity timeout.

A string describing the time. Possible values

INACTIVITY_TIMEOUTare:
0 minute
1 minute
2 minutes
3 minutes
4 minutes
5 minutes

API Reference Document for MobileIron WebService| 143

Policies

Security policy

Description

Valuesrule <type> field
15 minutes
30 minutes
1 hour
1.5 hours
2 hours
12 hours
24 hours

ClientValue: deprecated.
SECURITY_

The list of App Control Rules of type

A comma-separated list of numbers that

MANDATORY_

Required that are enabled in the security

correspond to App Control Rules of type

BMW_ACLS

policy.

Required. MobileIron Core assigned anumber to the App Control Rule when the
MobileIron Core administrator created therule. The list can be empty.
For example:
3
3,6
ClientValue: deprecated.

SECURITY_

The number of passwords remembered

PWD_

to ensure that users define a different

HISTORY

password.

Value: A number
ClientValue: deprecated.
Note that this field is applicable only if thepassword is mandatory.

SECURITY_

The minimum length for the password.

Value: A number

PWD_LENGTH
ClientValue: deprecated.

API Reference Document for MobileIron WebService| 144

Policies

Security policy

Description

Valuesrule <type> field
Note that this field is applicable only if thepassword is mandatory.
SECURITY_

The numbers of days after which theValue: The number of days.

PWD_MAX_password will expire. 0 indicates no limit.
ClientValue: deprecated.

AGE
SECURITY_

The maximum number of times the user

PWD_MAX_can enter an incorrect password before

FAILED_the device is wiped.

Value: A number.
ClientValue: deprecated.

ATTEMPTS

Note that this field is applicable only if thepassword is mandatory.

SECURITY_

The minimum number of special

Value: A number

COMPLEX_characters that must be included in a

ClientValue: deprecated.

CHAR

password.

SECURITY_

Whether a mandatory password

Value:

should be simple numeric input, bealphanumeric - restricted to alphanumeric

restricted to alphanumeric characters, orcharacters.

PWD_MIN_

PWD_TYPE

neither (that is, Don’t Care).
simple - restricted to simple numericcharacters.
simple,alphanumeric - restricted to either
simple or alphanumeric characters.
nc – no restrictions apply to the password
characters.
ClientValue: deprecated.
Note that this field is applicable only if thepassword is mandatory.
SECURITY_

Deprecated.

Deprecated.

QUARANTINE_
DEVICESAPI Reference Document for MobileIron WebService| 145

Policies

Security policy

Description

ValuesSECURITY_

Whether the user must enter a password

Value:REQUIRE_

before being able to access the device.

rule <type> field

on – a password is mandatory

PWD

off – a password is optional
ClientValue: deprecated.
SECURITY_

Deprecated.

Deprecated.

Deprecated.

Deprecated.

SECURITY_

The number of days before removing all

Value: A number.

WIPE

data from the device if the MobileIron

REQUIRE_
VPN
SECURITY_VPN_PROFILE

Client does not connect to the MobileIron

ClientValue: deprecated.

Server.

Lockdown policy rules
The following table shows the rules for lockdown policies, listed alphabetically by the name of the <type> field.
Note: Not all the lockdown rules apply to all device types.
For information about lockdown policies, see the MobileIron® Administration Guide.

API Reference Document for MobileIron WebService| 146

Policies

Lockdown

Description

ValuesLOCKDOWN_

Whether Bluetooth should be disabled in theon – Bluetooth audio and data should not

BLUETOOTH

event that device access must be restricted.

be disabled.

policy rule
<type> fieldaudio - Bluetooth audio should not bedisabled, but Bluetooth data should bedisabled.
off – Bluetooth audio and data should bedisabled.
ClientValue: deprecated.
LOCKDOWN_

Whether the camera should be disabled in the

CAMERAevent that device access must be restricted.

on – the camera should not be disabled.
off – the camera should be disabled.
ClientValue: deprecated.

LOCKDOWN_

Whether infrared should be disabled in the

IRDA

event that device access must be restricted.

on – infrared should not be disabled.
off – infrared should be disabled.
ClientValue: deprecated.

LOCKDOWN_

Whether the SD card should be disabled in

SDCARDthe event that device access must be

on – the SD card should not be disabled.
off – the SD card should be disabled.

restricted.

ClientValue: deprecated.
LOCKDOWN_

Whether WIFI should be disabled in the event

WIFI

that device access must be restricted.

on – WIFI should not be disabled.
off – WIFI should be disabled.
ClientValue: deprecated.

Sync policy rules
The following table shows the rules for sync policies, listed alphabetically by the name of the <type> field..
Note: Not all the sync rules apply to all device types.
For information about sync policies, see the MobileIron® Administration Guide.

API Reference Document for MobileIron WebService| 147

Policies

Sync policy

Description

ValuesSYNC_

Whether the MobileIron client app should remainon – Remain connected.

ALWAYS_

connected to MobileIron Core during the sync interval.

rule <type>
field

off – Do not remain connected.

CONNECTED

ClientValue: deprecated.
SYNC_APN_

Whether an Access Point Name (APN) connection

HOME_

type should be used in a Blackberry’s home network.

on – Use an APN connection type.
off – Do not use an APN

NETWORK

connection type.
ClientValue: deprecated.
SYNC_APN_

Whether an Access Point Name (APN) connection

ROAMING_

type should be used in a Blackberry’s roaming

NETWORK

network.

on – Use an APN connection type.
off – Do not use an APN
connection type.
ClientValue: deprecated.

SYNC_BIS_

Whether a Blackberry Internet Service (BIS)

HOME_

connection type should be used in a Blackberry’s

NETWORK

home network.

on – Use a BIS connection type.
off – Do not use a BIS connection
type.
ClientValue: deprecated.

SYNC_BIS_

Whether a Blackberry Internet Service (BIS)

ROAMING_

connection type should be used in a Blackberry’s

NETWORKroaming network.

on – Use a BIS connection type.
off – Do not use a BIS connection
type.
ClientValue: deprecated.

SYNC_

Whether to synch when the device is roaming.

on – Synchronization of all activity

BLOCK_and content occurs even whenWHEN_

roaming.

ROAMINGmai – Synchronization of only
voice, SMS, and data traffic
occurs when roaming.

API Reference Document for MobileIron WebService| 148

Policies

Sync policy

Description

Valuesrule <type>
field
roamingStatus – Synchronizationis blocked when roaming. Sync
only new country notification whenroaming.
off – Synchronization of all activity
and content is blocked whenroaming.
ClientValue: deprecated.
SYNC_FULL_

Deprecated.

Deprecated.

SYNC_

The maximum amount of time that the MobileIron

A number in minutes.

HEARTBEAT_

client app will wait before sending a request to the

INTERVAL

MobileIron server to confirm that the client and server

BG_MODEare connected.

For example:
14
ClientValue: deprecated.

SYNC_

The frequency for starting

A number in minutes.

the synchronization process

For example: 240

between the device and theClientValue: deprecated.

INTERVAL

MobileIron server.
SYNC_MIN_

The percentage of battery power at which to

BATTERY_

synchronize files between the device and the

POWER

MobileIron Server.

A number.
For example:
20

SYNC_MIN_

The minimum battery level

A percentage.

UPLOAD_(%) to use for writing data from the device to

For example:

BATTERY_

MobileIron Core during the synchronization process.

FILE_

POWER

60

API Reference Document for MobileIron WebService| 149

Policies

Sync policy

Description

Valuesrule <type>
field
ClientValue: deprecated.
SYNC_

The minimum duration between attempts to send iOS

MULTITASK_

device details to MobileIron Core.

A number in minutes.
For example:

INVERVAL

15
ClientValue: deprecated.
SYNC_

Whether to use Transport

on – Using TLS is required.

Layer Security for interactions

off – Using TLS is not required.

between MobileIron Core and the MobileIron client

ClientValue: deprecated.

REQUIRE_TLS

app on the device.
SYNC_

Whether to include files from removable storageon – Include files from removable

SDCARDdevices, such as SD cards, when synchronizing files

storage.

between the device and MobileIron Core.
off – do not include files fromremovable storage.
ClientValue: deprecated.
SYNC_

The IP address or host name of MobileIron Core that

For example:

the MobileIron client communicates with.

someServerName.mydomain.com

SERVERIP

ClientValue: deprecated.

Privacy policy rules
The following table shows the rules for privacy policies, listed alphabetically by the name of the <type> field..
Not all the privacy rules apply to all device types.
For information about privacy policies, see the MobileIron® Administration Guide.

API Reference Document for MobileIron WebService| 150

Policies

Privacy policy

Description

Values

PRIVACY_

Whether the iOS MobileIron client periodicallyon – Periodically wakes up.

APP_

performs functions without user interaction.

rule <type> fieldoff – Does not periodically wake up.

MULTITASKClientValue: deprecated.
PRIVACY_

The file folders that are excluded fromContains a <resourceDTOs> element

EXCLUDE_synchronization.

for each excluded folder.

DIR
For example:<resourceDTOs><name> /Windows</name>resourceType>DIR</resourceType><value>on</value></resourceDTOs><name> - lists the excluded directory.

<resourceType> - always has value
DIR.

<value> - always has value on.
PRIVACY_

Deprecated.

Deprecated.

1. Deprecated.

Deprecated.

LOG_APP_ACTIVITYPRIVACY_LOG_FILE_
ACTIVITY

API Reference Document for MobileIron WebService| 151

Policies

Privacy policy

Description

ValuesDeprecated.

Deprecated.

PRIVACY_

Whether to sync information about the installed

track – Sync apps.

SYNC_APPS

apps.

rule <type> field
PRIVACY_LOG_WEBSITE_ACTIVITY

off – Do not sync apps.
ClientValue: deprecated.
PRIVACY_

Deprecated.

Deprecated.

Whether to collect statistics on voice calls.

store – Collect voice call statistics.

SYNC_
BOOKMARKSPRIVACY_
SYNC_
off – Do not collect voice call

CALLLOGS

statistics.
ClientValue: deprecated.
PRIVACY_

Whether to sync contacts.

store – Sync contacts.

SYNC_
off – Do not sync contacts.

CONTACTS

ClientValue: deprecated.
PRIVACY_

Whether to sync data traffic statistics.

track – Sync data traffic.

SYNC_DATA_
off - Do not sync data traffic.

LOG
PRIVACY_

Whether to sync documents.

store – Sync documents.

SYNC_
off – Do not sync documents.

DOCUMENTS

ClientValue: deprecated.
PRIVACY_

Whether to sync the location to the cell tower, theSYNC_

device’s GPS position, or not at all.

LOCATION

celltower – Sync cell tower data.
gps – Sync GPS data.
off – Do not sync location data.

API Reference Document for MobileIron WebService| 152

Policies

Privacy policy

Description

ValuesWhether to sync music files.

store – Sync music files.

rule <type> field
PRIVACY_SYNC_MUSIC
off – Do not sync music files.
ClientValue: deprecated.
PRIVACY_

Whether to sync other files not specified by other

The file extensions of the types of files

SYNC_

privacy settings.

not to sync, as a comma-separated

OTHER_

list. For example:

MEDIA
ram,wav
No <value> element means sync filesof all types not specified by otherprivacy settings.
PRIVACY_

Whether to sync pictures.

store – Sync pictures.

SYNC_
off – Do not sync pictures.

PICTURES

ClientValue: deprecated.
PRIVACY_

Whether to collect SMS statistics, collect SMS

SYNC_

statistics and store SMS data on the MobileIron

SMSLOGS

server, or do neither.

track – Collect SMS statistics.
store – Collect SMS statistics andstore SMS data.
off – Do not collect SMS statistics orstore SMS data.
ClientValue: deprecated.

PRIVACY_

Whether to sync video files.

store – Sync video files.

SYNC_VIDEO
off – Do not sync video files.
ClientValue: deprecated.

API Reference Document for MobileIron WebService| 153

11Application Settings
Get all Application Settings
This API returns the list of all application settings across all devices in the MobileIron system.
Example:https://mycore.mobileiron.com/api/v1/appsettings

URI:

Returns list of all

https://{host-name}/api/v1/appsettings

appsettings.

Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the
response is returned.

Request:
type

This will allow the user
to filter the Application
settings by type.
Application settings
types EXCHANGE, WIFI,BOOKMARK, EMAIL,
VPN, GENERAL,CALDAV, SUBCAL,WEBCLIP, SCEP,
APN, RESTRICTION,
CERTIFICATE, MDM,PROVISIONING,CARDDAV,API Reference Document for MobileIron WebService| 154

Application Settings

CONFIGURATION,
OTHER

Note: SCEP is the typeused for all Certificate
Enrollment settings.
Response:<appSettingsWebServiceResponse><messages><message> 1 application settting(s) returned.</message>

Status Message.
Appsettings count isshown if the method
execution is
successful.
A descriptive error
message is shown if
the method execution
failed.

</messages><appsettings><appsetting id="-4"><name> System - iOS MDM CA Certificate</name>Application setting
name.

<description>This CA Certificate is distributed in conjunction with the

Description.

system MDM profile. It is the certificate that the mobile device will trust for the
purpose of accepting OTA MDM requests.</description><appType>CERTIFICATE</appType>

Application type<deviceCount>2</deviceCount>

Number of devices forwhich the app setting isapplied.

API Reference Document for MobileIron WebService| 155

Application Settings<pendingCount>1</pendingCount>

Number of devices forwhich the app setting ispending.

<quarantinedCount>0</quarantinedCount>

The number of devices
that have had thecorresponding
configuration (i.e.,
profile) removed due topolicy violations.

<type>SYSTEM</type>

System or Admin
generated.

<clearCertificateCacheForSCEPSetting>false</clearCertificateCacheForSCEPS

Not currently used.

etting><labels>-4</labels>

The ID of a label towhich this app setting
is assigned. This entry
appears once for eachlabel to which the app
setting is assigned.

<labelNames>iOS</labelNames>

The displayed name ofa label to which thisapp setting is
assigned. This entry
appears once for eachlabel to which the app
setting is assigned.

<properties>

Configuration
properties for theappsetting<entry><key>CERT_SERIAL_NUMBER0</key><value>10863527040561121251</value></entry><entry>API Reference Document for MobileIron WebService| 156

Application Settings<key>CERTPATH0</key><value>/mi/files/groups/9002/99415d0e64ca8708/b34aab3122e3410e98a2ef5a078
806ce</value></entry><entry><key>ENABLE_MIRRORING</key>

This setting is todisable or enable iOS
mirroring.

<value>false</value></entry><entry><key>SUPPORT_MULTIPLE_CONSUMERS</key>

This setting is aproperty pertaining to
SCEP settings. It
indicates if the SCEP
setting is being
consumed by multiple
app settings, forexample, like
Exchange and vpn.
••

If
CACHE_
KEYS=TRUE,
SUPPORT_
MULTIPL
E_
CONSUM
ERS isusually
FALSE/NULL (bothwill work)
If
CACHE_API Reference Document for MobileIron WebService| 157

Application Settings

KEYS=FALSE,
SUPPORT_
MULTIPL
E_
CONSUM
ERS is
FALSE if it
is being
consumedby only
one appsetting,and TRUE
if it is being
consumedby multiple
apps.
<value>false</value></entry>….

Can have multiple
entries.

</properties></appsetting></appsettings></appSettingsWebServiceResponse>

Get Application Settings by Device UUIDThis API returns the list of all application settings for a given device uuid in the MobileIron system.
Example:https://mycore.mobileiron.com/api/v1/appsettings/devices/12849438-0d74-3c30-6b7d121a3da8645d

API Reference Document for MobileIron WebService| 158

Application Settings

URI:

Returns list

https://{host-name}/api/v1/appsettings/devices/{deviceuuid}of allappsettings
by device
uuid.

Http Method:

GET

Format:xml, json

Response Status Code:‘404 – No Data Found’

There is nodata.

‘200 – OK’

Data ispresent andtheresponse isreturned.

Response:<appSettingsWebServiceResponse><messages><message> 1 application settting(s) returned.</message>

StatusMessage.
Appsettings
count isshown if themethodexecution is
successful.
Adescriptive
error
message isshown if themethodAPI Reference Document for MobileIron WebService| 159

Application Settings

execution
failed.
</messages><appsettings><appsetting id="-4"><name> System - iOS MDM CA Certificate</name>Application
setting
name.

<description>This CA Certificate is distributed in conjunction with the system MDM

Description.

profile. It is the certificate that the mobile device will trust for the purpose of accepting OTA
MDM requests.</description><appType>CERTIFICATE</appType>

Application
type<deviceCount>0</deviceCount>

This field is
notapplicablefor thisrequest.

<pendingCount>0</pendingCount>

This field is
notapplicablefor thisrequest.

<type>SYSTEM</type>

System or
Admin
generated.

<state>67</state>

67 = ASCII"C" =Current
68 = ASCII"D" =Deleted<clearCertificateCacheForSCEPSetting>false</clearCertificateCacheForSCEPSetting>

API Reference Document for MobileIron WebService| 160

Application Settings<properties>

Configuration properties
for theappsetting<entry><key>CERT_SERIAL_NUMBER0</key><value>10863527040561121251</value></entry><entry><key>CERTPATH0</key><value>/mi/files/groups/9002/99415d0e64ca8708/b34aab3122e3410e98a2ef5a078806ce</va
lue></entry>….

Can have
mulitiple
entires.

</properties></appsetting></appsettings></appSettingsWebServiceResponse>

API Reference Document for MobileIron WebService| 161

12

AppConnect for iOS and Android Analytics
Get Analytics for AppConnect Apps
This API returns a ZIP file that contains AppConnect analytics for a specified AppConnect app. The ZIP filecontains CSV files, one for each device on which the AppConnect app has run. Each CSV file provides statistics
about AppConnect app usage on a device.
The ZIP file has the following folder structure:<app ID><first device ID>
CSV file
version.txt file
<second device ID>
CSV file
version.txt file

Each CSV file contains one row per app session. Each row contains:••

the start time of the foreground session, given in seconds since January 1, 1970 (Unix time).
Example: 1381268056367
the duration of the session, given in seconds

Example: 35••

the timezone where the session occurred, given in minutes from Greenwich Mean Time.
Example for Pacific Daylight Time: -420
the number of bytes the app transferred during the session (under construction)

Each version.txt file contains the version number of the AppConnect app.
Examples:
https://mycore.mobileiron.com/api/v1/apps/appconnect/analytics?appid=com.mycompany.myapp

URI:

Returns ZIP file containing usage statistics for the specified app.

https://{hostname}/api/v1/apps/appconnect/analytics
Http Method:

GET

Format:xml, json

API Reference Document for MobileIron WebService| 162

AppConnect for iOS and Android Analytics

Response Status Code:‘404 – No Data Found’

There is no data.

‘200 – OK’

Data is present and the response is returned.

Request:appid

Required.

The app ID of the AppConnect app for which you want theanalytics CSV files.

For iOS AppConnect apps, the app ID is the bundle ID. For
Android AppConnect apps, it is the package name.

API Reference Document for MobileIron WebService| 163

13

Testing from a browser
If you use a browser to send one of the web services HTTP requests, URL encode the requests. For example,
replace any white space with %20. For a plus sign (+), use %2B. For example, URL-encode Email+ as Email%2B.
For details about URL-encoding, see http://www.w3schools.com/tags/ref_urlencode.asp.

API Reference Document for MobileIron WebService| 164

14

Test Client
A sample http test client implemented in Java is provided below. You can access this client on the MobileIron
support site: https://support.mobileiron.com/support/clients/mobileiron-api-httpclient.zip.
1. Unzip the file, mobileiron-api-httpclient.zip . Below is the directory structure of the test client.
client|-- pom.xml`-- src|-- main||-- java||`-- com||`-- mobileiron|||-- rs|||`-- client||`-- ws||`-- client||`-- http|||-- AlertWebServiceHttpClient.java|||-- AppStoreWebServiceHttpClient.java|||-- DMWebServiceHttpClient.java|||-- EASWebServiceHttpClient.java|||-- MAIWebServiceHttpClient.java|||-- SMWebServiceHttpClient.java||`-- WebServiceHttpClientBase.java|`-- resources||-- applicationContext-miws-client.xml||-- miws-client.properties|`-- miws-v1.wadl`-- test|-- java|`-- com|`-- mobileiron||-- rs|`-- ws|`-- client|`-- http|`-- WebServiceHttpClientTest.java`-- resources`-- log4j.xml

2. Edit the properties in miws-client.properties under src/main/resources.
webservice.hostname=<your mobileiron appliance host name or IP Address>
webservice.url=/api
webservice.version=/v1
user name who has the ‘API’ role assigned.
webservice.username=miadmin
Password of the above user.
webservice.password=<password>

See Chapter- 2 Authentication

API Reference Document for MobileIron WebService| 165

Test Client

3. Change directory to client and execute maven to build and run the test client.
cd client
mvn clean install

The above mvn command will do a clean build and execute the test client. The output of the tests are printed on the
console and to a file named miws-test.log in the ‘client’ directory.

API Reference Document for MobileIron WebService| 166

15

Change Log
Date

Description

September 8, 2020

Removed documentation for:l

List labels for a devicelApply labels to a devicelRemove labels from a device

See Deprecation update - September 8, 2020 for complete details.
July 17, 2019

Rebranded with new MobileIron logos.

January 18, 2019

Added note that ServiceNow can use the register, retire, wipe, lock, unlock,locate, and wakeup a device calls.

December 14, 2018

Added notifyuserbysms parameter to Register a Device call.

June 5, 2018

Changed title page to reflect 10.0.0.0.

March 6, 2018

Changed title page to reflect 9.7.0.0.

November 1, 2017

Changed title page to reflect 9.6.0.0.

August 9, 2017

Removed the following calls because MobileIron no longer supports them:•••sm/certificates/upload
sm/certificates/delete
sm/certificates/list

API Reference Document for MobileIron WebService| 167