Lock a Device
This API locks a device, which typically forces the user to enter a passcode (either a user-generated or Ivanti EPMM-generated password) to access the device and prevents the user from reversing this restriction. Devices are locked based on unique device ID (uuid). As all mobile operating systems behave differently, refer to the Administration Guide for details on lock support.
You can use this API with ServiceNow.
Examples:
https://<Ivanti EPMM>/api/v1/dm/devices/lock/ee8198d9-5d79-4961-94c4-e21bf04b2467?Reason=User%20lost%20device
https://<Ivanti EPMM>/api/v1/dm/devices/lock/mac/38AA3C62BFAD?Reason=User%20lost%20device
1. URI: https:///api/v1/dm/devices/lock/ | Device with the input device uuid is locked. |
|---|---|
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. |
Reason | Required. Free form text field (512 character limit) to display reason why the device is being locked. |
| |
1. URI: https:///api/v1/dm/devices/lock/mac/ | Device with the Wi-Fi MAC address is locked. |
Http Method: | PUT |
Format: | xml, json |
Request: | |
macAddress | Required. |
Reason | Required. 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. |
Response: | |
<deviceManagementWebServiceResponse> | |
<messages> | |
<message>Device is locked successfully.</message> | Status 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-79e32e91adf8</deviceUuid> | Unique device ID. This field is not included for Android and iOS devices. |
<unlockpasscode>12345</unlockpasscode> | Passcode to unlock the device. If this is missing, then the device was most likely locked with the user-set passcode. This field is not included for Android and iOS devices. |
< /deviceManagementWebServiceResponse > | |
| |
