Device API Calls

Assign a Device to a User

This call assigns a device to a user. This call only works for supervised iOS devices.

Required User Permissions

This call requires tenant admin credentials.

HTTP Method

PUT

Request URI

/api/v1/device/updateAccount

Request Parameters

Example Request

curl --location --request PUT 'https://<mobileiron_cloud>]/api/v1/device/updateAccount' \ --header 'Accept: application/json, text/plain, */*' \ --data-urlencode 'accountId=10542407' \ --data-urlencode 'deviceIds=73542'

Response Fields

Example Response

{

    "errors": null,

    "result": 1

}

Get Custom Attributes Per Device

This API returns a list of custom attributes for the target device. You can use the device ID or GUID to identify the target device.

Required User Permissions

Device Management or Device Read Only.

HTTP Method

GET

Request URI

/api/v1/device/{id}|{guid}/customattributes

Request Parameters

Example Requests

curl GET -kv -u user:password "https://[mobileiron_cloud]/api/v1/device/22000/customattributes”

curl GET -kv -u user:password "https://[mobileiron_cloud]/api/v1/device/57d9903c-aadf-4b40-aef3-e1f24302f180/customattributes”

Example Response

 
{
    “attrs” : 
    {
        “cityId” : “SF”,
        “carrier” : “att”
    }
}

Add/Replace Custom Attributes Per Device

You can use this API call to assign a custom attribute, for example,  cityId,  to the device. You could then use this custom attribute to create a device group for all devices with that cityId. You can use the device ID or GUID to identify the target device. The call posts a request body consisting of a JSON payload containing a map of string attributes.

The POST method completely replaces the attributes on the device with the call’s payload, deleting any existing attribute on the device not defined in the payload.

Required User Permissions

Device Management.

HTTP Method

POST to replace all values with the call’s payload.

Request URI

/api/v1/device/{id}|{guid}/customattributes

Request Parameters

Example Request URLs

http://[mobileiron cloud]/api/v1/device/22000/customattributes

curl -X POST -kv -u user:password -H 'Content-Type: application/json' -d '{ "attrs" : { "tlark" : [ "1" ] } } ' "https://[mobileiron_cloud]/api/v1/device/22000/customattributes"

curl -X POST -kv -u user:password -H 'Content-Type: application/json' -d '{ "attrs" : { "tlark" : [ "1" ] } } ' "https://[mobileiron_cloud]/api/v1/device/8bcc4cee-dca9-476d-8710-9bb1e738ade9/customattributes"

Example Request Body

{
    "attrs": {
        "cityid": [
            "SF"
        ]
    }
}

Patch custom attributes per device

You can use this API call to patch a custom attribute, for example,  cityId, of the device. You can use the device ID or GUID to identify the target device. The call posts a request body consisting of a JSON payload containing a map of string attributes.

The PATCH method retains attributes not defined in its payload, updates existing custom attributes, and adds custom attributes to the device that do not exist.

Required User Permissions

Device Management.

HTTP Method

PATCH to retain attributes not defined in the payload, update existing custom attributes, and add custom attributes to the device that do not exist.

Request URI

/api/v1/device/{id}|{guid}/customattributes

Request Parameters

{
    "attrs": {
        "key-1": [
            "value-1"
        ]
    }

{
    "attrs": {
        "a": [
            "value_a_patched"
        ]
    }

 "forceOverwrite": true

Example Requests

Given these existing attributes:

{
    "errors": null,
    "result": {
        "deviceId": 22000,
        "guid": "e77fc91f-445d-4797-b8f1-a412279952e1",
        "attrs": {
            "a": [
                "valuea"
            ],
            "b": [
                "valueb"
            ]
        }
    }
}

Use this request to overwrite attribute a only:

curl --location --request PATCH 'https://[mobileiron_cloud]/api/v1/device/57d9903c-aadf-4b40-aef3-e1f24302f180/customattributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxaW5AYWNtZS5jb206TWk0bWFuMSEyITMh' \
--header 'Content-Type: text/plain' \
--data-raw '{"attrs":{"a":["value_a_patched"]}, "forceOverwrite":true}'

Use this request to overwrite both attributes a and b:

curl --location --request PATCH 'https://[mobileiron_cloud]/api/v1/device/57d9903c-aadf-4b40-aef3-e1f24302f180/customattributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxaW5AYWNtZS5jb206TWk0bWFuMSEyITMh' \
--header 'Content-Type: text/plain' \
--data-raw '{"attrs":{"a":["value_a_patched"], "b":["value_b_patched"]}, "forceOverwrite":true}'

Use this request to add new attribute c:

curl --location --request PATCH 'https://[mobileiron_cloud]/api/v1/device/57d9903c-aadf-4b40-aef3-e1f24302f180/customattributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxaW5AYWNtZS5jb206TWk0bWFuMSEyITMh' \
--header 'Content-Type: text/plain' \
--data-raw '{"attrs":{"c":["value_c_added"]}, "forceOverwrite":true}'

Example Response

{

    "errors": null,

    "result": 1
}

Remove custom attributes per device - method 1

You can use this API call to remove selected custom attributes of the device. The call posts a request body as a JSON payload consisting of the device ID and a map of string attributes to remove.

Required User Permissions

Device Management.

HTTP Method

DELETE

Request URI

/api/v1/device/customattributes

Request Parameters

{
    "ids": [
        "73542"
    ], 
    "attrKeys": [
        "ForDocs001", 
        "forDocs002"
    ]
}

{
    "ids": [
        "73542"
    ], 
    "attrKeys": [
        "ForDocs001", 
        "forDocs002"
    ]
}

Example Requests

Example Request URLs

curl --location --request DELETE 'https://<mobileiron cloud>/api/v1/device/customattributes' \ --header 'Accept: application/json, text/plain, */*' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic xxxxxEBzYW5kYm94Lm1vYmlsZWlyb24uY29tOk1pNG1hbjEx' \ --data-raw '{"ids":["73542"],"attrKeys":["ForDocs001","forDocs002"]}'

Example Request Body, Formatted

{
    "ids": [
        "73542"
    ], 
    "attrKeys": [
        "ForDocs001", 
        "forDocs002"
    ]
}

Example Response

{

    "errors": null,

    "result": 1
}

Remove custom attributes per device - method 2

You can use this API call to remove selected custom attributes of the device. The call posts a request body as a JSON payload consisting of the attributes to remove. This leaves in place the attributes not sent in the call.

Required User Permissions

Device Management.

HTTP Method

DELETE

Request URI

/api/v1/device/{ID or GUID}/customattributes

Request Parameters

{
    "attrs": {
        "attribute1": [
            "1"
        ]
    }
}

{
    "attrs": {
        "attribute1": [
            "1"
        ]
    }
}

Example Request

curl --location --request DELETE 'https://[mobileiron_cloud]/api/v1/device/d67f2d3b-4ea7-44c6-9fb7-5f4107184e34/customattributes' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic xxxxxEBzYW5kYm94Lm1vYmlsZWlyb24uY29tOk1pNG1hbjEx' \ --data-raw '{ "attrs" : { "attribute1" : [ "1" ] } } '

Example Response

{

    "errors": null,

    "result": 1
}

Get Device Details

This call gets the device details of a specific device. Details include, among other attributes, the device groups to which it belongs and last known location.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

/api/v1/device/deviceId

Request Parameters

Response Fields

Example Request

https://[mobileiron_cloud]/api/v1/device/22001

Example Response

{
    "errors": null,
    "result": {
        "id": 92752,
        "guid": "ed6b6e18-892f-4059-b605-def424308c4d",
        "mdmChannelId": "850a62ec-c29a-42ff-b9e2-16846cf5eb2d",
        "phoneNumber": null,
        "deviceModel": "iPad4,5",
        "deviceName": "iPad",
        "platformType": "IOS",
        "platformVersion": "12.4.4",
        "osBuildVersion": "16G140",
        "lastCheckin": 1578404119952,
        "registrationState": "ACTIVE",
        "displayName": "praveen kh",
        "firstName": "praveen",
        "lastName": "kh",
        "uid": "[email protected]",
        "emailAddress": "[email protected]",
        "clientVersion": null,
        "manufacturer": "Apple Inc.",
        "imei": "35 884805 038514 5",
        "imei2": null,
        "imsi": null,
        "locatorServiceEnabled": true,
        "meid": "35884805038514",
        "wifiMacAddress": "6c:70:9f:29:fe:d7",
        "serialNumber": "DLXMF0URFLMK",
        "altSerialNumber": null,
        "cellularTechnology": "GSM/CDMA",
        "currentCarrierNetwork": "UNKNOWN",
        "subscriberCarrierNetwork": "UNKNOWN",
        "locale": null,
        "ownershipType": "UNKNOWN",
        "complianceState": true,
        "roaming": true,
        "supervised": false,
        "udid": "f4e9953b586208023fc582ef2206f7f4b9389321",
        "clientLastCheckin": null,
        "iccid": null,
        "currentMcc": null,
        "currentMnc": null,
        "subscriberMcc": "",
        "subscriberMnc": "",
        "prettyModel": "iPad Mini 2nd gen",
        "policyViolationCount": 0,
        "latitude": null,
        "longitude": null,
        "locationLastCapturedAt": null,
        "lastRegistrationTime": 1578033658080,
        "lostModeEnabled": false,
        "multiUser": false,
        "clientDeviceIdentifier": null,
        "availableCapacity": 6.575844,
        "totalCapacity": 11.340248,
        "clusterIdentifier": "CLOUD",
        "deviceSource": "CLOUD",
        "quarantined": false,
        "jailbroken": false,
        "passcodeCompliant": false, 
        "passcodeCompliantWithProfiles": false,
        "blocked": null,
        "locationStatusDetail": null,
        "androidBuildFingerprint": null,
        "androidBuildId": null,
        "androidZebraPatchLevel": null,
        "androidSystemUpdateStatus": null,
        "salesCode": null,
        "uptime": null,
        "androidWorkContainerEnabled": false,
        "androidWorkUid": null,
        "fcmEnabled": false,
        "actionExceptionCodes": [],
        "violatedPolicies": null,
        "supportLockMessage": true,
        "ownerId": 10586408,
	 "legalOwnerId": null, 
        "legalOwnerEmailAddress": null,
        "kioskState": "NOT_CONFIGURED",
        "customAttributes": null,
        "easDeviceIdentifiers": [
            "IKTFNGAVQT7B1BLBD1NKUCVQ4S"
        ],
        "appEasIdentifiers": null,
        "androidDeviceOwnerModeEnabled": false,
        "windowsDeviceType": null,
        "secureAppsStatus": null,
        "secureAppsEncryptionStatus": null,
        "secureAppsEncryptionMode": null,
        "tpmSpecificationVersion": null,
        "bridgeVersion": null,
        "bridgeDeviceDataLastCapturedAt": null,
        "lastHotfixId": null,
        "lastHotfixInstalledOn": null,
        "mamOnly": false,
        "depEnrolled": false,
        "depEligible": false,
        "mobileThreatDefenseGeneralStatus": "NA",
        "antiPhishingGeneralStatus": "NA",
        "samsungEfotaCapable": false,
        "currentCountryName": null,
        "currentCountryCode": null,
        "homeCountryName": null,
        "homeCountryCode": null,
        "userPreferenceCSVHeader": null,
        "dmPartitionId": 23504,
        "dmPartitionName": null,
        "androidSecurityPatchLevel": "2018-01-01",
        "clientAppBundleId": null,
        "groups": [
            {
                "id": 40165,
                "createdAt": 1444416984710,
                "createdBy": 1,
                "modifiedAt": 1444416984710,
                "modifiedBy": null,
                "visible": true,
                "dmPartitionId": 23504,
                "name": "All Devices",
                "description": "Targets any type of device.",
                "type": "DEVICE",
                "definition": null,
                "mutable": false,
                "memberCount": 0,
                "systemName": "ALL_DEVICES",
                "membershipStatic": false,
                "treeView": null,
                "actionExceptionCodes": null,
                "assignedConfigs": null,
                "assignedPolicies": null,
                "staticMembers": null
            },
            {
                "id": 40167,
                "createdAt": 1444416984710,
                "createdBy": 1,
                "modifiedAt": 1444416984710,
                "modifiedBy": null,
                "visible": true,
                "dmPartitionId": 23504,
                "name": "iOS Devices",
                "description": "Targets all iOS devices",
                "type": "DEVICE",
                "definition": "PLATFORMTYPE EQ 'IOS'",
                "mutable": false,
                "memberCount": 0,
                "systemName": "IOS_DEVICES",
                "membershipStatic": false,
                "treeView": {
                    "operator": "LEAF",
                    "rule": {
                        "field": "PLATFORMTYPE",
                        "cfAttributeName": null,
                        "operator": "EQ",
                        "values": [
                            "IOS"
                        ]
                    },
                    "children": null
                },
                "actionExceptionCodes": null,
                "assignedConfigs": null,
                "assignedPolicies": null,
                "staticMembers": null
            }
        ],
        "privacyPolicy": {
            "policyId": 42501,
            "policyName": "Privacy",
            "locateStatus": "ENABLED",
            "wipeDisabled": false,
            "appInventoryCollectAllEnabled": true
        },
        "tos": {
            "title": "test",
            "body": "test1"
        },
        "tosAcceptedTime": 1578033658080,
        "tosId": 50955,
        "restrictions": null,
        "dataRoamingEnabled": false,
        "appConnectCheckInTime": null,
        "antiPhishingStatus": "NA",
        "mobileThreatDefenseStatus": "NA",
        "appFeedbackLastSync": null,
        "activationLockEnabled": true,
        "bypassCode": null,
        "cloudBackupEnabled": true,
        "networkTethered": false,
        "lastCloudBackupDate": 1577955629000,
        "mirroringStatus": null,
        "voiceRoamingEnabled": false,
        "availableOSUpdate": null,
        "availableOSUpdates": [],
        "serviceSubscriptions": [
            {
                "carrierSettingsVersion": null,
                "currentCarrierNetwork": null,
                "currentMCC": null,
                "currentMNC": null,
                "esimIdentifier": null,
                "iccid": null,
                "imei": "35 884805 038514 5",
                "isDataPreferred": false,
                "isVoicePreferred": false,
                "label": null,
                "labelID": null,
                "phoneNumber": null,
                "slot": "CTSubscriptionSlotOne"
            }
        ],
        "timeZone": "Asia/Kolkata",
        "osxFdeEnabled": false,
        "osxFdeHasInstitutionalRecoveryKey": false,
        "osxFdeHasPersonalRecoveryKey": false,
        "bootstrapTokenAvailable": null, 
        "osxFirewallSettings": null,
        "osxSystemIntegrityProtectionEnabled": false,
        "osxAutoAdminAccountShortName": null,
        "osxFirmwarePasswordStatus": null,
        "osxFirmwarePasswordCommandStatus": null,
        "availableMacOSUpdates": null,
        "passcodeLockGracePeriodEnforced": null,
        "androidId": null,
        "androidSecurityPatchLevel": null,
        "androidWorkCapable": false,
        "androidWorkEnabled": false,
        "androidZebraCapable": false,
        "helpAtWorkAvailable": false,
        "samsungSafeCapable": false,
        "androidEnterpriseKioskLogoutEnabled": false,
        "androidWorkProfileEnabled": false,
        "androidDeviceOwnerEnabled": false,
        "androidWorkDeviceOwnerWithWorkProfileEnabled": false,
        "aadDeviceId": null,
        "winDmClientChannelUri": null,
        "windowsEncrypted": false,
        "wipConfigured": false,
        "applockerConfigured": false,
        "wipMandatorySettingsConfigured": false,
        "batteryEstimatedChargeRemaining": null,
        "batteryEstimatedRuntime": null,
        "osPlatform": null,
        "osEdition": null,
        "deviceFamily": null,
        "androidSafetyNetAttestationType": null,
        "aadBulkEnrolled": false,
        "enrollerId": null,
        "changeOwnerCounter": 0,
        "aadEnrolled": false,
        "apnsCapable": true,
        "clientRegistered": false,
        "mdmDeviceIdentifier": "f4e9953b586208023fc582ef2206f7f4b9389321",
        "itunesAccountActive": true,
        "winServiceSubscriptions": null
    }
}

Get Device Details Based on Attribute

This call gets the device details based on a custom device or LDAP attribute, for example, cityID as a custom device attribute, or a device attribute, for example, GUID.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URIs

Device custom attrribute:

/api/v1/device?fq=CFDEVICE[customAttributeName]=value&dmPartitionId=id

LDAP custom attrribute:

/api/v1/device?fq=CFLDAP[customAttributeName]=value&dmPartitionId=id

Attribute:

/api/v1/device?fq=attributeName=value&dmPartitionId=id

Request Parameters

Response Fields

Example Request

https://[mobileiron_cloud]/api/v1/device?fq=CFDEVICE%5BcityId%5D=SF&dmPartitionId=23000

Example Response

{
    "errors": null,
    "result": {
        "totalCount": 1,
        "searchResults": [
            {
                "id": 22004,
                "guid": "50459445-0f9e-456a-b485-534842acdf9f",
                "mdmChannelId": "be016af4-bd88-406d-ae48-82947f0a0eaf",
                "phoneNumber": "",
                "deviceModel": "Pixel 2",
                "deviceName": null,
                "platformType": "ANDROID",
                "platformVersion": "9.0",
                "osBuildVersion": null,
                "lastCheckin": 1546491367278,
                "registrationState": "RETIRED",
                "displayName": "a1 b",
                "firstName": "a1",
                "lastName": "b",
                "uid": "[email protected]",
                "emailAddress": "[email protected]",
                "clientVersion": "60.0.0.262",
                "manufacturer": "Google",
                "imei": "",
                "imsi": "",
                "locatorServiceEnabled": false,
                "meid": "",
                "wifiMacAddress": "40:4e:36:8c:db:2d",
                "serialNumber": "",
                "cellularTechnology": "device__p_cellular_technology",
                "currentCarrierNetwork": "UNKNOWN",
                "subscriberCarrierNetwork": "UNKNOWN",
                "locale": "en_US",
                "ownershipType": "UNKNOWN",
                "complianceState": true,
                "roaming": false,
                "supervised": null,
                "udid": null,
                "clientLastCheckin": 1546491367278,
                "iccid": "",
                "currentMcc": "0",
                "currentMnc": "0",
                "subscriberMcc": "0",
                "subscriberMnc": "0",
                "prettyModel": "Pixel 2",
                "policyViolationCount": 0,
                "latitude": null,
                "longitude": null,
                "locationLastCapturedAt": null,
                "lastRegistrationTime": 1546491255252,
                "lostModeEnabled": null,
                "multiUser": null,
                "clientDeviceIdentifier": "684da0b411e03de9c30a76d5ee04f77575f8b5d27396c73e65c14c137a560663",
                "quarantined": false,
                "jailbroken": false,
                "passcodeCompliant": null, 
                "passcodeCompliantWithProfiles": true,
                "blocked": false,
                "locationStatusDetail": null,
                "androidWorkContainerEnabled": false,
                "androidWorkUid": null,
                "fcmEnabled": false,
                "actionExceptionCodes": [],
                "violatedPolicies": [],
                "supportLockMessage": false,
                "ownerId": 10900,
		"legalOwnerId": null, 
        	 "legalOwnerEmailAddress": null,
                "kioskState": "NOT_CONFIGURED",
                "customAttributes": {
                    "attrs": {
                        "cityid": [
                            "SF"
                        ]
                    }
                },
                "easDeviceIdentifiers": [
                    "bfe2136ea6602a80"
                ],
                "appEasIdentifiers": null,
                "androidDeviceOwnerModeEnabled": false,
                "windowsDeviceType": null,
                "secureAppsStatus": "FALSE",
                "secureAppsEncryptionStatus": "FALSE",
                "secureAppsEncryptionMode": "NONE",
                "tpmSpecificationVersion": null,
                "bridgeVersion": null,
                "bridgeDeviceDataLastCapturedAt": null,
                "lastHotfixId": null,
                "lastHotfixInstalledOn": null,
                "mamOnly": false,
                "depEnrolled": false,
                "depEligible": false
            }
        ],
        "offset": 0,
        "queryTime": 10,
        "facetedResults": {
            "LAST_HOTFIX_ID": {},
            "SUBSCRIBERCARRIERNETWORK": {
                "UNKNOWN": 1
            },
            "ANDROIDDEVICEOWNERMODEENABLED": {
                "false": 1
            },
            "PRETTYMODEL": {
                "Pixel 2": 1
            },
            "REGISTRATIONSTATE": {
                "RETIRED": 1
            },
            "MULTIUSER": {
                "false": 1
            },
            "ACCOUNTENABLED": {
                "true": 1
            },
            "ANDROIDWORKPROFILEENABLED": {
                "false": 1
            },
            "KIOSKSTATE": {
                "NOT_CONFIGURED": 1
            },
            "ANDROIDSECURITYPATCHLEVEL": {
                "2018-12-05": 1
            },
            "JAILBROKEN": {
                "false": 1
            },
            "PLATFORMTYPE": {
                "ANDROID": 1
            },
            "OWNERSHIPTYPE": {
                "UNKNOWN": 1
            },
            "ANTI_PHISHING_STATUS": {
                "UNKNOWN": 1
            },
            "ANDROIDSAFETYNETATTESTATIONTYPE": {
                "UNKNOWN": 1
            },
            "ANDROIDWORKDEVICEOWNERWITHWORKPROFILEENABLED": {
                "false": 1
            },
            "COMPLIANCESTATE": {
                "true": 1
            },
            "SUPERVISED": {
                "false": 1
            },
            "SECUREAPPSSTATUS": {
                "FALSE": 1
            },
            "MAMONLY": {
                "false": 1
            },
            "ACCOUNTGROUP": {
                "All Users": 1
            },
            "ANDROIDWORKENABLED": {
                "false": 1
            },
            "OSBUILDVERSION": {},
            "ROAMING": {
                "false": 1
            },
            "LOSTMODEENABLED": {
                "false": 1
            }
        },
        "totalUnfilteredResultCount": 0
    }
}

Get Device Configuration

This call gets device configurations on a specific device.

Authentication

This call requires tenant admin credentials.

HTTP Method

GET

Request URI

api/v1/device/{id}/configs

Request Parameters

Example Request

  https://[mobileiron cloud]/api/v1/device/22200/configs 

Response Fields

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 6,

    "queryTime": 0,

    "searchResults": [

      {

        "id": 35046,

        "name": "Passcode Config",

        "systemName": null,

        "description": "Corporate device passcode config",

        "policyType": "PASSCODE",

        "policyRuleType": "NONE",

        "uuid": "bd330bef-1ae8-4fe4-bdb7-dfbea2193aa1",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      },

      {

        "id": 37859,

        "name": "Identity for the App Catalog",

        "systemName": null,

        "description": "The Identity used by this device to access the iOS App Catalog securely.",

        "policyType": "IDENTITY_CERTIFICATE_DG",

        "policyRuleType": "NONE",

        "uuid": "d48ed5cf-6fcb-47cf-b569-80ed3eeb201a",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      },

      {

        "id": 35161,

        "name": "MobileIron Corp Wifi",

        "systemName": null,

        "description": "WiFi for MobileIron corporate",

        "policyType": "WIFI",

        "policyRuleType": "NONE",

        "uuid": "35403a2b-52e7-48ed-9df6-598f3dbaec89",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      },

      {

        "id": 35148,

        "name": "MobileIron Cloud-Exchange-MS2",

        "systemName": null,

        "description": "",

        "policyType": "EXCHANGE",

        "policyRuleType": "NONE",

        "uuid": "acb5e979-2928-4799-999b-49e218e6bfc0",

        "enabled": true,

        "priority": 2,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      },

      {

        "id": 35037,

        "name": "App Catalog",

        "systemName": null,

        "description": "Access the iOS App Catalog via this Web Clip.",

        "policyType": "WEBCLIP",

        "policyRuleType": "NONE",

        "uuid": "c7a8ed81-0322-405f-90bc-5c1134a5ea5d",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      },

      {

        "id": 35162,

        "name": "MobileIron Corporate SSL",

        "systemName": null,

        "description": null,

        "policyType": "VPN",

        "policyRuleType": "NONE",

        "uuid": "5812cc6a-ba6b-4dd0-b879-403420cba703",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "status": "INSTALLED"

      }

    ],

    "offset": 0,

    "limit": 6

  }

}

Remove a Configuration from a Device

This call removes a configuration from a device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

/api/v1/device/{id}/uninstallconfigs

Request Parameters

Example Request

curl 'https://[mobileiron cloud]/api/v1/device/197483/uninstallconfigs' -X PUT -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json, text/plain, */*' --data 'policyIds=47269'

Example Response

{

    "errors": null,

    "result": true

}

Delete a Configuration from the Uninstalled List

This call removes a configuration from the list of configurations added to the uninstalled list. For example, if you used the Remove a Configuration from a Device call to remove a configuration from a device, you can use this call to add the configuration back to the device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

DELETE

Request URI

api/v1/device/{id}/uninstallconfigs?policyIds={policyIds}

Request Parameters

Example Request

curl 'https://[mobileiron cloud]/api/v1/device/197483/uninstallconfigs?policyIds=47269' -X DELETE -H 'Accept: application/json, text/plain, */*'

Example Response

{

    "errors": null,

    "result": true

}

Push a Configuration to a Device

This call pushes a configuration to a device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/{id}/reinstallconfigs

Request Parameters

Example Request

curl 'https://[mobileiron cloud]/api/v1/device/197483/reinstallconfigs' -X PUT -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json, text/plain, */*' --data 'policyIds=54694'

Example Response

{

    "errors": null,

    "result": true

}

Get Compliance Status of a Particular Device

Gets the compliance status of a device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

api/v1/device/{id}/policies

Request Parameters

Example Request

https://cluster056.auto.acme.com/api/v1/device/22000/policies

Response Fields

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 4,

    "queryTime": 0,

    "searchResults": [

      {

        "id": 35009,

        "name": "Compromised Devices",

        "systemName": null,

        "description": "Checks for devices which are compromised.",

        "policyType": "POLICY",

        "policyRuleType": "COMPROMISED",

        "uuid": "ad452ba7-2922-41e6-9720-3c229c70f95c",

        "enabled": true,

        "priority": 1,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "compliant": true,

        "pendingCompliant": true

      },

      {

        "id": 35011,

        "name": "MDM / Device Administration Disabled",

        "systemName": null,

        "description": "Checks for devices which do not have MDM/Device Administration Enabled.",

        "policyType": "POLICY",

        "policyRuleType": "MDM_DISABLED",

        "uuid": "c9b7891c-7f98-4bb1-a28c-1dab0e532916",

        "enabled": true,

        "priority": 3,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "compliant": true,

        "pendingCompliant": true

      },

      {

        "id": 35012,

        "name": "Out of Contact ",

        "systemName": null,

        "description": "Checks for devices which have been out of contact for the specified time.",

        "policyType": "POLICY",

        "policyRuleType": "OUT_OF_CONTACT",

        "uuid": "4edbe47b-2ce2-4a45-a9df-c2e8c03e3fd6",

        "enabled": true,

        "priority": 4,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "compliant": true,

        "pendingCompliant": true

      },

      {

        "id": 35010,

        "name": "International Roaming Devices",

        "systemName": null,

        "description": "Checks for devices which are currently roaming.",

        "policyType": "POLICY",

        "policyRuleType": "ROAMING",

        "uuid": "0f70be4a-19a5-4ecb-9d04-a9127a4a613f",

        "enabled": true,

        "priority": 2,

        "totalDeviceCount": 0,

        "installedDeviceCount": 0,

        "violationDeviceCount": 0,

        "modifiedAt": null,

        "modifiedBy": null,

        "actions": null,

        "compliant": false,

        "pendingCompliant": false

      }

    ],

    "offset": 0,

    "limit": 4

  }

}

Check Force Check-in Viability

This call determines whether a device can be force checked-in.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

api/v1/device/forceCheckin?checkViability=true&ids=ids

Request Parameters

Example Request

https://[mobileiron cloud]/api/v1/device/forceCheckin?checkViability=true&ids=22062&ids=22196

Example Response

{

    "errors": null,

    "result": {

        "totalCount": 0,

        "queryTime": 0,

        "searchResults": [ ],

        "offset": 0,

        "limit": 0

    }

}

Force check in a device or devices

This call forces a single or multiple devices to check in. You can use device IDs or GUIDs (global unique identifier) as parameters. The parameters of this call are included in a request body, however, you can issue them as query parameters, and the server will parse them into a request body for you.

Required User Permissions

Device Actions or Device Management.

HTTP Method

PUT

Request URI

/api/v1/device/forceCheckin

Request Parameters

Example Requests

curl "https://[mobileiron cloud]/api/v1/device/forceCheckin" -X PUT --data "ids=22062&ids=22196"

curl -X PUT -kv -u user:password "https://[mobileiron cloud]/api/v1/device/forceCheckin?ids=22000”

curl -X PUT -kv -u user:password "https://[mobileiron cloud]/api/v1/device/forceCheckin?guids=57d9903c-aadf-4b40-aef3-e1f24302f180”

Example Response

{

  "errors": null,

  "result": 2

}

Check Wipe Viability

This call determines whether a device can be wiped.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

api/v1/device/wipe

Request Parameters

Example Request

https://[mobileiron cloud]/api/v1/device/wipe?checkViability=true&ids=22000

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 0,

    "queryTime": 0,

    "searchResults": [ ],

    "offset": 0,

    "limit": 0

  }

}

Wipe device

This call wipes a device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/wipe

Request Body Parameters

Example Request

curl –X PUT “https://[mobileiron cloud]/api/v1/device/wipe” –d “ids=22000”

Example Response

{

  "errors": null,

  "result": 1

}

Check Lock viability

This call checks whether a device can be locked.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

api/v1/device/lock

Request Parameters

Example Request

https://[mobileiron cloud]/api/v1/device/lock?checkViability=true&ids=22000

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 0,

    "queryTime": 0,

    "searchResults": [ ],

    "offset": 0,

    "limit": 0

  }

}

Lock a device or devices

This call locks a single or several devices. You can use device IDs or GUIDs (global unique identifier) as parameters. The parameters of this call are included in a request body, however, you can issue them as query parameters, and the server will parse them into a request body for you.

Required User Permissions

Device Actions or Device Management.

HTTP Method

PUT

Request URI

api/v1/device/lock

Request Parameters

Example Requests

curl –X PUT “https://[mobileiron cloud]/api/v1/device/lock” –d “ids=22000”

curl -X PUT -kv -u user:password "https://[mobileiron cloud]/api/v1/device/lock?ids=22000”

curl -X PUT -kv -u user:password "https://[mobileiron cloud]/api/v1/device/lock?guids=57d9903c-aadf-4b40-aef3-e1f24302f180”

Example Response

{
  "errors": null,
  "result": 1
}

Unlock a device or devices

This call unlocks a single or several devices.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/unlock

Request Parameters

Example Request

curl –X PUT “https://mobileiron cloud/api/v1/device/unlock” –d “ids=22000”

Example Response

{

  "errors": null,

  "result": 1

}

Check Retire Viability

This call checks whether a device can be retired

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

api/v1/device/retire

Request Parameters

Example Request

https://[mobileiron cloud]/api/v1/device/retire?checkViability=true&ids=22000

Example Response

{

  "errors": null,

  "result": {

    "totalCount": 0,

    "queryTime": 0,

    "searchResults": [ ],

    "offset": 0,

    "limit": 0

  }

}

Retire device

This call retires a device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/retire

Request Parameters

Example Request

curl –X PUT “https://[mobileiron cloud]/api/v1/device/retire” –d “ids= 1007966”

Example Response

{

  "errors": null,

  "result": 1

}

Delete Device

This call deletes a device. You must run the Retire device call first before deleting the device.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

DELETE

Request URI

/api/v1/device?deviceIds={id}

Request Parameters

Example Request

curl 'https://[mobileiron cloud]/api/v1/device?deviceIds=1007966' -X DELETE

Example Response

{

  "errors": null,

  "result": 1

}

Send a device or devices a message

This call sends a device or devices a push notification message.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

/api/v1/device/message

Request Parameters

Example Request

curl "https://[mobileiron_cloud]/api/v1/device/message" -X PUT  --data "sendPushNotification=true&pushNotificationMessage=Docs+test+of+bulk+messages&sendEmail=false&emailSubject=&emailBody=&dmPartitionId=23003&q=&deviceIds=370872"%"2C383279"

Example Response

{

    "errors": null,

    "result": true

}

Check Enter Kiosk Mode Viability

This call checks whether a device can be entered into kiosk mode.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

/api/v1/device/enterKioskMode?checkViability=true&ids=deviceIds

Request Parameters

Example Request

https://[mobileiron cloud]/api/v1/device/enterKioskMode?checkViability=true&ids=22000

Example Response

{

    "errors": null,

    "result": {

        "totalCount": 0,

        "queryTime": 0,

        "searchResults": [ ],

        "offset": 0,

        "limit": 0

    }

}

Enter a Device into Kiosk Mode

This call enters a device into Kiosk mode and is available for Android devices only.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/enterKioskMode

Request Parameters

Example Request

curl -X PUT 'https://[mobileiron_cloud]/api/v1/device/enterKioskMode' --data 'ids=22000'

Example Response

{

  "errors": null,

  "result": 1

}

Remove Device from Kiosk Mode

This call removes a device from Kiosk mode and is available for Android devices only.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

PUT

Request URI

api/v1/device/exitKioskMode

Request Parameters

Example Request

curl –X PUT “https://[mobileiron cloud]/api/v1/device/exitKioskMode” –d “ids=22000”

Example Response

{

  "errors": null,

  "result": 1

}

Get List of Devices Registered Within x Amount of Time

This call gets a list of devices registered within the last x days, hours, minutes, and seconds.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

/api/v1/device?dmPartitionId=dmPartitionId&fq=lastRegistrationTime<'dd:hr:mm:ss'&rows=rows&start=start

Request Parameters

Example Request

http://[mobileiron_cloud]/api/v1/device?dmPartitionId=23003&fq=lastRegistrationTime<'0:0:03:06'&rows=5&start=0

Response Fields

Example Response

{

    "errors": null,

    "result": {

        "totalCount": 1,

        "queryTime": 28,

        "searchResults": [

            {

                "id": 394985,

                "phoneNumber": "+15558555543",

                "deviceModel": "XT1095",

                "platformType": "ANDROID",

                "platformVersion": "5.0",

                "lastCheckin": 1426183813073,

                "registrationState": "ACTIVE",

                "displayName": "Bill Smith",

                "firstName": "Bill",

                "lastName": "Smith",

                "uid": "[email protected]",

                "emailAddress": " [email protected]",

                "clientVersion": "3.0.1.3",

                "manufacturer": "motorola",

                "imei": "353345061657294",

                "wifiMacAddress": "f8:cf:c5:00:b1:4a",

                "serialNumber": "TA44908O8E",

                "currentCarrierNetwork": "T-Mobile",

                "subscriberCarrierNetwork": "UNKNOWN",

                "locale": "en_US",

                "ownershipType": "UNKNOWN",

                "complianceState": true,

                "roaming": false,

                "supervised": null,

                "udid": null,

                "clientLastCheckin": 1426183813073,

                "iccid": "8901260222782933598",

                "currentMcc": "310",

                "currentMnc": "260",

                "subscriberMcc": "310",

                "subscriberMnc": "260",

                "prettyModel": "XT1095",

                "policyViolationCount": 0,

                "latitude": null,

                "longitude": null,

                "locationLastCapturedAt": null,

                "lastRegistrationTime": 1426183707585,

                "locationStatusDetail": null,

                "actionExceptionCodes": [

                    null

                ],

                "supportLockMessage": false,

                "ownerId": 10220,

                "legalOwnerId": null,

                "legalOwnerEmailAddress": null,

                "kioskState": "NOT_CONFIGURED",

                "customAttributes": null

            }

        ],

        "offset": 0,

        "limit": 5,

        "facetedResults": {

            "PRETTYMODEL": {

                "SM-N900V": 0,

                "iPad": 0,

                "GT-I9505": 0,

                "SAMSUNG-SM-N900A": 0,

                "HTC 802w": 0,

                "SM-N900T": 0,

                "GT-I9500": 0,

                "SAMSUNG-SGH-I337": 0,

                "Nexus 9": 0,

                "GT-N8013": 0,

                "iPhone": 0,

                "MI 2S": 0,

                "SM-G900F": 0,

                "SM-T210R": 0,

                "SM-G900H": 0,

                "SC-02E": 0,

                "SM-G530H": 0,

                "Nexus 4": 0,

                "SAMSUNG-SGH-I727": 0,

                "iPod touch": 0,

                "Nexus 5": 0,

                "SM-T530NU": 0,

                "SPH-L720": 0,

                "Nexus 6": 0,

                "Nexus 7": 0,

                "SM-T320": 0,

                "iPhone 4s": 0,

                "SM-P600": 0,

                "iPad Mini": 0,

                "GT-I9105P": 0,

                "SGH-M919": 0,

                "SCH-I535": 0,

                "C6802": 0,

                "A0001": 0,

                "SC-03D": 0,

                "GT-P3113": 0,

                "iPhone 3Gs": 0,

                "DROID RAZR": 0,

                "LG-D858HK": 0,

                "SAMSUNG-SM-G900A": 0,

                "iPad 2": 0,

                "iPhone 5s": 0,

                "XT1095": 1,

                "Galaxy Nexus": 0,

                "GT-N7000": 0,

                "iPhone 6 Plus": 0,

                "iPad4,7": 0,

                "iPad5,3": 0,

                "iPad5,4": 0,

                "Nexus 10": 0,

                "Lumia 520": 0,

                "iPhone 5c": 0,

                "GT-P5113": 0,

                "SCH-I545": 0,

                "MacBookAir6,2": 0,

                "SAMSUNG-SGH-I317": 0,

                "GT-N7105": 0,

                "LG-D851": 0,

                "SAMSUNG-SGH-I747": 0,

                "GT-N7100": 0,

                "iPad 4th gen": 0,

                "iPhone3,2": 0,

                "iPod touch 4th gen": 0,

                "HTC One X": 0,

                "SM-N910G": 0,

                "XT1080": 0,

                "Lumia 635": 0,

                "GT-I9000": 0,

                "iPad 3rd gen": 0,

                "iPad Air": 0,

                "Lumia 925": 0,

                "iPhone 4": 0,

                "SCH-I915": 0,

                "iPhone 5": 0,

                "iPhone 6": 0,

                "HTC One": 0,

                "GT-I9300": 0,

                "iPod touch 5th gen": 0,

                "Lumia 630": 0,

                "iPad Mini 2nd gen": 0,

                "iPhone Simulator": 0,

                "SC-01F": 0,

                "MacBookAir4,2": 0,

                "Nexus S": 0

            },

            "COMPLIANCESTATE": {

                "false": 0,

                "true": 1

            },

            "OWNERSHIPTYPE": {

                "COMPANY": 0,

                "EMPLOYEE": 0,

                "UNKNOWN": 1

            },

            "SUBSCRIBERCARRIERNETWORK": {

                "Verizon": 0,

                "vf nl": 0,

                "Viettel": 0,

                "ドコモ": 0,

                "KDDI": 0,

                "T-Mobile": 0,

                "AT&T": 0,

                "ATT-US": 0,

                "中国移动": 0,

                "Sprint": 0,

                "Vodafone India": 0,

                "movistar": 0,

                "Vodafone.de": 0,

                "OPTUS": 0,

                "UNKNOWN": 1,

                "NTT DOCOMO": 0,

                "Airtel TZ": 0,

                "vodafone UK": 0,

                "TELCEL": 0,

                "airtel": 0,

                "SingTel": 0,

                "YES OPTUS": 0,

                "Singtel": 0,

                "AirTel": 0,

                "000-IN": 0,

                "Carrier": 0,

                "CMCC": 0,

                "Telekom.de": 0,

                "中国联通": 0,

                "Verizon Wireless": 0,

                "EE": 0,

                "Telstra": 0

            },

            "JAILBROKEN": {

                "true": 0,

                "false": 1

            },

            "ACCOUNTGROUP": {

                "Professional Services": 0,

                "xteam": 0,

                "UX Test Group": 0,

                "Sales": 1,

                "EMEA-ISR": 0,

                "MiOnMi-AllO365": 1,

                "UG2": 0,

                "Demo Group": 0,

                "hari": 0,

                "Russ": 0,

                "UX Team": 0,

                "Test Group - Created by/for [email protected]": 0,

                "Newell North America": 0,

                "洋一テストユーザーグループ": 0,

                "Customer Success": 0,

                "IT Test Group": 0,

                "Engineering": 0,

                "Business Development": 0,

                "Newell Georgia": 0,

                "MIMIC-o365Test": 0,

                "Marketing": 0,

                "EMEA-Partner-Helpdesk": 0,

                "all-productmanagers": 0,

                "UX": 0,

                "Newell": 0,

                "RichardLi": 0,

                "Users Not Syncing groups": 0,

                "SE": 1,

                "QA": 0,

                "SAFE - Native Samsung Users": 0,

                "Roupen Group": 0,

                "IT": 0,

                "Local Users - Unable to Link to AD": 0,

                "System Administrators": 0,

                "Supervised Devices": 0,

                "Vinay Parihar": 0,

                "Tyson Wheeler - Android": 0,

                "MIOnMI-AllServices": 0,

                "UG1": 0,

                "RamseyNJesse": 0,

                "Default Group": 1,

                "All Users": 1,

                "Sales Ops": 0,

                "Chris Kim": 0,

                "CN": 0,

                "Japan": 0,

                "Mirko": 0

            },

            "REGISTRATIONSTATE": {

                "RETIRED": 0,

                "WIPE_CANCELED": 0,

                "RETIRE_CANCELED": 0,

                "RETIRE_SENT": 0,

                "WIPE_PENDING": 0,

                "WIPE_SENT": 0,

                "WIPED": 0,

                "RETIRE_PENDING": 0,

                "ACTIVE": 1

            },

            "SUPERVISED": {

                "true": 0,

                "false": 1

            },

            "ROAMING": {

                "true": 0,

                "false": 1

            },

            "PLATFORMTYPE": {

                "ANDROID": 1,

                "IOS": 0,

                "WINDOWS_PHONE": 0,

                "OSX": 0

            },

            "KIOSKSTATE": {

                "NOT_CONFIGURED": 1,

                "INACTIVE": 0,

                "ACTIVE": 0

            }

        },

        "totalUnfilteredResultCount": 503

    }

}

Get List of Devices Checked In Within x Amount of Time

This call gets a list of devices checked in within the last x seconds, minutes or hours. The call returns such fields, for example, as availableCapacity and totalCapacity, to aid troubleshooting why apps are not installing.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

/api/v1/device?dmPartitionId=dmPartitionId&fq=lastCheckin<'hh:mm:ss'&rows=rows&start=start

Request Parameters

Example Request

https://[mobileiron_cloud]/api/v1/device?dmPartitionId=23003&fq=lastCheckin<'00:01:00'&rows=5&start=0

Response Fields

Example Response

{
    "errors": null, 
    "result": {
        "totalCount": 1, 
        "searchResults": [
            {
                "id": 89073, 
                "guid": "50cf8b26-4514-4f16-b0b8-2b4a5f9a965d", 
                "mdmChannelId": "50f0321c-f12d-492e-99c1-61bbbe31b4ef", 
                "phoneNumber": null, 
                "deviceModel": "iPad7,5", 
                "deviceName": "Micloud’s iPad", 
                "platformType": "IOS", 
                "platformVersion": "12.4", 
                "osBuildVersion": "16G77", 
                "lastCheckin": 1597793723830, 
                "registrationState": "ACTIVE", 
                "displayName": "ad fs", 
                "firstName": "ad", 
                "lastName": "fs", 
                "uid": "[email protected]", 
                "emailAddress": "[email protected]", 
                "clientVersion": null, 
                "manufacturer": "Apple Inc.", 
                "imei": null, 
                "imei2": null, 
                "imsi": null, 
                "locatorServiceEnabled": true, 
                "meid": null, 
                "wifiMacAddress": "60:8c:4a:ac:b6:24", 
                "wifiMacAddressForInventory": null, 
                "systemUpdateInformation": null, 
                "serialNumber": "GG7XCJ38JF8K", 
                "altSerialNumber": null, 
                "cellularTechnology": "device__p_cellular_technology", 
                "currentCarrierNetwork": "UNKNOWN", 
                "subscriberCarrierNetwork": "UNKNOWN", 
                "locale": null, 
                "ownershipType": "UNKNOWN", 
                "complianceState": true, 
                "roaming": false, 
                "supervised": false, 
                "udid": "aa02889fa80c43e2e22f33d12ff12d564d735d49", 
                "clientLastCheckin": null, 
                "iccid": null, 
                "currentMcc": null, 
                "currentMnc": null, 
                "subscriberMcc": null, 
                "subscriberMnc": null, 
                "prettyModel": "iPad 6th gen", 
                "policyViolationCount": 0, 
                "latitude": null, 
                "longitude": null, 
                "locationLastCapturedAt": null, 
                "lastRegistrationTime": 1597349037211, 
                "lostModeEnabled": false, 
                "multiUser": false, 
                "maxResidentUsers": null, 
                "clientDeviceIdentifier": null, 
                "availableCapacity": 17.063477, 
                "totalCapacity": 22.111652, 
                "clusterIdentifier": "CLOUD", 
                "deviceSource": "CLOUD", 
                "quarantined": false, 
                "jailbroken": false, 
                "passcodeCompliant": true, 
                "passcodeCompliantWithProfiles": true, 
                "blocked": false, 
                "locationStatusDetail": null, 
                "androidBuildFingerprint": null, 
                "androidBuildId": null, 
                "androidZebraPatchLevel": null, 
                "androidSystemUpdateStatus": null, 
                "salesCode": null, 
                "firmwareVersion": null, 
                "uptime": null, 
                "userEnrolled": false, 
                "androidWorkContainerEnabled": false, 
                "androidWorkUid": null, 
                "androidManagedByGoogle": false, 
                "fcmEnabled": false, 
                "actionExceptionCodes": [ ], 
                "violatedPolicies": [ ], 
                "supportLockMessage": true, 
                "ownerId": 12206107,
                "legalOwnerId": null, 
                "legalOwnerEmailAddress": null,  
                "kioskState": "NOT_CONFIGURED", 
                "legalOwnerId": null, 
                "legalOwnerEmailAddress": null, 
                "customAttributes": null, 
                "easDeviceIdentifiers": [
                    "LQQEGK4VED1H75L0S40DBA9MB8"
                ], 
                "appEasIdentifiers": null, 
                "androidDeviceOwnerModeEnabled": false, 
                "windowsDeviceType": null, 
                "secureAppsStatus": null, 
                "secureAppsEncryptionStatus": null, 
                "secureAppsEncryptionMode": null, 
                "tpmSpecificationVersion": null, 
                "bridgeVersion": null, 
                "bridgeDeviceDataLastCapturedAt": null, 
                "lastHotfixId": null, 
                "lastHotfixInstalledOn": null, 
                "mamOnly": false, 
                "authOnly": false, 
                "ipAddress": null, 
                "depEnrolled": false, 
                "depEligible": false, 
                "mobileThreatDefenseGeneralStatus": "NA", 
                "antiPhishingGeneralStatus": "NA", 
                "samsungEfotaCapable": false, 
                "currentCountryName": null, 
                "currentCountryCode": null, 
                "homeCountryName": null, 
                "homeCountryCode": null, 
                "userPreferenceCSVHeader": null, 
                "dmPartitionId": 23504, 
                "dmPartitionName": "Default Space", 
                "entityName": "Micloud’s iPad"
            }
        ], 
        "offset": 0, 
        "queryTime": 5, 
        "facetedResults": {
            "LAST_HOTFIX_ID": { }, 
            "SUBSCRIBERCARRIERNETWORK": {
                "UNKNOWN": 1
            }, 
            "AUTHONLY": {
                "false": 1
            }, 
            "ANDROIDWORKPROFILEONCOMPANYOWNEDDEVICEENABLED": {
                "false": 1
            }, 
            "ANDROIDDEVICEOWNERMODEENABLED": {
                "false": 1
            }, 
            "PRETTYMODEL": {
                "iPad 6th gen": 1
            }, 
            "REGISTRATIONSTATE": {
                "ACTIVE": 1
            }, 
            "DEVICESOURCE": {
                "CLOUD": 1
            }, 
            "MULTIUSER": {
                "false": 1
            }, 
            "ACCOUNTENABLED": {
                "true": 1
            }, 
            "ANDROIDWORKPROFILEENABLED": {
                "false": 1
            }, 
            "KIOSKSTATE": {
                "NOT_CONFIGURED": 1
            }, 
            "ANDROIDSECURITYPATCHLEVEL": { }, 
            "JAILBROKEN": {
                "false": 1
            }, 
            "PLATFORMTYPE": {
                "IOS": 1
            }, 
            "OWNERSHIPTYPE": {
                "UNKNOWN": 1
            }, 
            "ANDROIDSAFETYNETATTESTATIONTYPE": {
                "UNKNOWN": 1
            }, 
            "ANDROIDWORKDEVICEOWNERWITHWORKPROFILEENABLED": {
                "false": 1
            }, 
            "COMPLIANCESTATE": {
                "true": 1
            }, 
            "MOBILE_THREAT_DEFENSE_GENERAL_STATUS": {
                "NA": 1
            }, 
            "SUPERVISED": {
                "false": 1
            }, 
            "ANTIPHISHINGGENERALSTATUS": {
                "NA": 1
            }, 
            "SECUREAPPSSTATUS": { }, 
            "MAMONLY": {
                "false": 1
            }, 
            "ANDROIDMANAGEDBYGOOGLE": {
                "false": 1
            }, 
            "ACCOUNTGROUP": {
                "All Users": 1, 
                "ADFS IDP": 1
            }, 
            "ANDROIDWORKENABLED": {
                "false": 1
            }, 
            "OSBUILDVERSION": {
                "16G77": 1
            }, 
            "ROAMING": {
                "false": 1
            }, 
            "LOSTMODEENABLED": {
                "false": 1
            }
        }, 
        "totalUnfilteredResultCount": 0
    }
}

List Devices by UID or Email Address

This call lists devices by UID or by email address.

Authentication

This call requires Tenant Admin credentials.

HTTP Method

GET

Request URI

/api/v1/device

Request Parameters

Example Request

https://[mobileiron_cloud]/api/v1/device?q=&dmPartitionId=23505&fq=EMAILADDRESS+EQ+ [email protected]

or

https://[mobileiron_cloud]/api/v1/device?q=&dmPartitionId=23505&fq=UID+EQ+ [email protected]

Example Response

{

    "errors": null,

    "result": {

        "totalCount": 1,

        "searchResults": [

            {

                "id": 197483,

                "mdmChannelId": null,

                "phoneNumber": "+447480308390",

                "deviceModel": "iPhone6,2",

                "deviceName": "iPhone",

                "platformType": "IOS",

                "platformVersion": "8.1.2",

                "osBuildVersion": "12B440",

                "lastCheckin": 1422649201021,

                "registrationState": "ACTIVE",

                "displayName": "Stuart Cordery",

                "firstName": "Stuart",

                "lastName": "Cordery",

                "uid": "[email protected]",

                "emailAddress": "[email protected]",

                "clientVersion": "2.9.0 (2.9.0.15)",

                "manufacturer": "Apple Inc.",

                "imei": "35 876105 566321 0",

                "imsi": null,

                "meid": null,

                "wifiMacAddress": "90:b9:31:73:5b:f6",

                "serialNumber": "F2LLMEE9FFG8",

                "cellularTechnology": "device__p_cellular_technology",

                "currentCarrierNetwork": "UNKNOWN",

                "subscriberCarrierNetwork": "Three",

                "locale": null,

                "ownershipType": "UNKNOWN",

                "complianceState": false,

                "roaming": true,

                "supervised": false,

                "udid": "f831a81049c541ad78b12e09db0849e06ad6dadb",

                "clientLastCheckin": 1422640798139,

                "iccid": "8944 2001 0071 0054 856",

                "currentMcc": "310",

                "currentMnc": "410",

                "subscriberMcc": "234",

                "subscriberMnc": "20",

                "prettyModel": "iPhone 5S",

                "policyViolationCount": 2,

                "latitude": 33.651546,

                "longitude": -117.99167,

                "locationLastCapturedAt": 1422640798182,

                "lastRegistrationTime": 1418162611699,

                "lostModeEnabled": false,

                "multiUser": false,

                "locationStatusDetail": {

                    "lastUpdatedAt": 1422640798182,

                    "locationStatus": "AVAILABLE"

                },

                "androidWorkContainerEnabled": false,

                "actionExceptionCodes": [ ],

                "supportLockMessage": true,

                "ownerId": 1110567,

                "legalOwnerId": null,

                "legalOwnerEmailAddress": null,

                "kioskState": "NOT_CONFIGURED",

                "customAttributes": null,

                "easDeviceIdentifiers": [

                    "ApplF2LLMEE9FFG8"

                ],

                "androidDeviceOwnerModeEnabled": false,

                "windowsDeviceType": null,

                "secureAppsStatus": null,

                "secureAppsEncryptionStatus": null,

                "secureAppsEncryptionMode": null

            }

        ],

        "offset": 0,

        "queryTime": 2,

        "facetedResults": {

            "SUBSCRIBERCARRIERNETWORK": {

                "Three": 1

            },

            "COMPLIANCESTATE": {

                "false": 1

            },

            "SUPERVISED": {

                "false": 1

            },

            "SECUREAPPSSTATUS": { },

            "ANDROIDDEVICEOWNERMODEENABLED": {

                "false": 1

            },

            "PRETTYMODEL": {

                "iPhone 5S": 1

            },

            "ACCOUNTGROUP": {

                "All Users": 1

            },

            "REGISTRATIONSTATE": {

                "ACTIVE": 1

            },

            "MULTIUSER": {

                "false": 1

            },

            "OSBUILDVERSION": {

                "12B440": 1

            },

            "KIOSKSTATE": {

                "NOT_CONFIGURED": 1

            },

            "ANDROIDWORKCONTAINERENABLED": {

                "false": 1

            },

            "ROAMING": {

                "true": 1

            },

            "LOSTMODEENABLED": {

                "false": 1

            },

            "JAILBROKEN": {

                "false": 1

            },

            "PLATFORMTYPE": {

                "IOS": 1

            },

            "OWNERSHIPTYPE": {

                "UNKNOWN": 1

            }

        },

        "totalUnfilteredResultCount": 0

    }

}

Get Device Enrollment Program (DEP) details by DEP profile ID

iOS only. This call returns DEP details by DEP profile ID. Apple allows customers to purchase devices in bulk and automatically enroll those devices in MDM during device activation. You can create a DEP profile and apply it to all devices associated with that MDM Server. This call returns details about a specific DEP profile.

Authentication

This call requires tenant admin credentials.

HTTP Method

GET

Request URI

/api/v1/depServer{id}/profiles

Request Parameters

{
    "errors": null, 
    "result": {
        "searchResults": [
            {
                "id": 198, 
                "serverUuid": "xxxxaa95-3bd7-4dde-8339-6218d43d8937", 
                ...
        "limit": 50
    }
}

Example Request

curl -X GET https://<mobileiron_cloud>/api/v1/depServer/198/profiles

Response Fields

Example Response

{
    "errors": null, 
    "result": [
        {
            "id": 51799, 
            "uuid": "27EF7B79448A485D9CF9F68038BB18DB", 
            "profileName": "QEJoe", 
            "allowPairing": true, 
            "softwareUpdateEnabled": false, 
            "anchorCerts": null, 
            "department": "QE-2", 
            "mandatory": false, 
            "mdmRemovable": true, 
            "maximumResidentUsers": 0, 
            "multiUser": false, 
            "orgMagic": "xxxxaa95-3bd7-4dde-8339-6218d43d8937", 
            "skipSetupItems": [
                "Biometric", 
                "Payment", 
                "Passcode"
            ], 
            "supervised": false, 
            "supervisingHostCerts": null, 
            "supportPhoneNumber": "1234567890", 
            "supportEmailAddress": null, [mobileiron_cloud]/c/i/dep/dep.mobileconfig", 
            "accountConfiguration": {
                "skipPrimarySetupAccountCreation": false, 
                "setPrimarySetupAccountAsRegularUser": false, 
                "skipAutoSetupAdminAccounts": true, 
                "autoSetupAdminAccounts": null
            }, 
            "showCustomTextOnLoginPage": false, 
            "customText": null, 
            "awaitDeviceConfig": false, 
            "timeLimit": 3, 
            "enableCustomEnrollment": false, 
            "configurationWebUrl": null, 
            "virtualServerId": 198, 
            "status": "ACTIVE", 
            "description": null, 
            "newProfileUuid": null, 
            "createdAt": null, 
            "createdBy": null, 
            "modifiedAt": null, 
            "modifiedBy": null, 
            "numOfDevices": 0, 
            "default": true
        }
    ]
}