Contents
| MobileIron Cloud Customer Integration API Guide |
|
| Copyright |
|
| About this Guide |
|
| Introduction |
|
| Assumptions |
|
| Revision History |
|
| Key Concepts |
|
| Supported Platforms |
|
| Understanding the MobileIron Cloud Account |
|
| Understanding Device Registration Authentication Type |
|
| Overview of System Emails |
|
| Glossary of Key Concepts |
|
| App Catalog |
|
| App Inventory |
|
| App |
|
| Categories |
|
| Configurations |
|
| Content |
|
| Device |
|
| Group |
|
| Policies |
|
| Role |
|
| MobileIron Cloud API Basics |
|
| System Role |
|
| Authentication |
|
| API Limits |
|
| HTTP Response Codes |
|
| Response Types |
|
| Controlling Results |
|
| The Importance of the Device Space ID |
|
| Making Your First API Calls |
|
| Assumptions and Prerequisites |
|
| Making a Few Simple Calls |
|
| Getting Account Information |
|
| Using Postman REST Client |
|
| Using cURL |
|
| Creating a User |
|
| Using Postman REST Client |
|
| Using cURL |
|
| User API Calls |
|
| Create User without Password |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Sample Request |
|
| Response Fields |
|
| Sample Response |
|
| Create User with Password |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Invite User |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get Enrollment URL |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get All Accounts |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Example Request |
|
| Example Response |
|
| Group API Calls |
|
| Create a User Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| List User Groups |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Check Delete Viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Delete Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Assign User to Group, Method 1 |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Assign User to Group, Method 2 |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Create a Device Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Request URL |
|
| Example Request Body |
|
| Response Fields |
|
| Example Response |
|
| Get List of Device Groups |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get General Information about a Device Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Response Fields |
|
| Example Request |
|
| Example Response |
|
| Get Device Details by Device Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Add or Remove a Device to or from a Device Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Add a Device to a Device Group |
|
| Remove a Device from a Device Group |
|
| Device API Calls |
|
| Assign a Device to a User |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get Custom Attributes Per Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Add/Replace Custom Attributes Per Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request URL |
|
| Example Request Body |
|
| Patch Custom Attributes Per Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Request URL |
|
| Example Request Body |
|
| Example Response |
|
| Remove Custom Attributes Per Device - method 1 |
|
| Remove Custom Attributes Per Device - method 2 |
|
| Get Device Details |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Response Fields |
|
| Example Request |
|
| Example Response |
|
| Get Device Details Based on Attribute |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Response Fields |
|
| Example Request |
|
| Example Response |
|
| Get Device Configuration |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Remove a Configuration from a Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Delete a Configuration from the Uninstalled List |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Push a Configuration to a Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Get Compliance Status of a Particular Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Sample Request |
|
| Response Fields |
|
| Sample Response |
|
| Check Force Check-in Viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Force check in a device or devices |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Check Wipe Viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Wipe device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Body Parameters |
|
| Example Request |
|
| Example Response |
|
| Check Lock viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Lock a device or devices |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Unlock a device or devices |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Sample Request |
|
| Sample Response |
|
| Check Retire Viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Retire device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Delete Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Send a device or devices a message |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Check Enter Kiosk Mode Viability |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Enter a Device into Kiosk Mode |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Remove Device from Kiosk Mode |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Get List of Devices Registered Within x Amount of Time |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get List of Devices Checked In Within x Amount of Time |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| List Devices by UID or Email Address |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Get Device Enrollment Program (DEP) details by DEP profile ID |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Custom Device Enrollment |
|
| Configuration API Calls |
|
| Get a List of Device Configurations |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Assign Configuration to Device Group |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Tenant Administration API Calls |
|
| Get Tenant Metadata |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get Device Spaces |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Apps API Calls |
|
| Search for Google Play Apps |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get Google Play App Info by Bundle ID |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Search for iTunes Apps |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get iTunes App Info by appStoreId |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get Application Inventory for a Particular Device |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get the List of Applications Available to a Particular User |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| List Devices with a Specific App in its App Inventory |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| URL Encoded: |
|
| Unencoded: |
|
| Response Fields |
|
| Example Response |
|
| Create an App |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| In-house App |
|
| Public App |
|
| Example Response |
|
| Update an App |
|
| Uploading the new APK file |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Copying Previous App Version Artifacts |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Update In-House App Screenshots |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Request Headers |
|
| Example Request |
|
| Example Response |
|
| Update In-House App Details |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Get a List of In-House Apps |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Delete an App |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Review and Rate an App |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Get All Reviews |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response Fields |
|
| Example Response |
|
| Delete an App Review |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Example Response |
|
| Create Application Configuration |
|
| Authentication |
|
| Request Format |
|
| Request Parameters |
|
| Response |
|
| Example Request |
|
| Example Response |
|
| Update Application Configuration |
|
| Authentication |
|
| Request Format |
|
| Request Parameters |
|
| Response |
|
| Example Request |
|
| Example Response |
|
| Custom Attributes Management |
|
| Certificate Management Calls |
|
| Get the Certificate Revocation List |
|
| Authentication |
|
| HTTP Method |
|
| Request URI |
|
| Request Parameters |
|
| Example Request |
|
| Response |
|
| Connector Management Calls |
|