Back to top

How to use Knox Device Management Service

Last updated June 26th, 2024

Knox Device Management Service is currently in private preview. Some features might be incomplete, or change without notice.

The Knox Device Management Service provides you with centralized device management across Knox cloud services, which allows you to manage your entire fleet of devices across Knox services from a single point, simplifying your device management process.

In this tutorial, you will learn how to:

  • Use Knox Device Management Service to upload and delete devices from Knox Asset Intelligence.
  • Get a list of devices through Knox Device Management Service.
  • Set up Knox Webhook Notification with Knox Device Management Service to receive callback notifications when asynchronous upload and delete operations are complete.

Prerequisites

  1. Register for a Samsung Knox account, then sign up for Knox Asset Intelligence.
  2. Get an OAuth 2.0 access token. Make sure that you include the kdms.devices scope when you create your OAuth 2.0 client application so you can access the Knox Device Management Service API. If you want to provide more granular access permissions, you can grant permissions specifically for upload, delete, and get operations with scopes kdms.devices:upload, kdms.devices:delete, and kdms.devices:read.

Upload devices to Knox Device Management Service

Upload a list of devices with the POST /devices/upload operation in the Knox Device Management Service API. This operation allows you to upload devices with a list of IMEIs or serial numbers.

In the request header, add the Authorization parameter with value Bearer <your-oauth2.0-access-token> to authenticate your request. For details, see Call Knox cloud services APIs with access token.

In the request body, set targetServices to KAI so that these devices can be used by Knox Asset Intelligence.

You can subscribe to Knox Webhook Notification with the KDMS_DEVICE_UPLOAD event to receive notifications once the asynchronous device upload operation is complete. For more information, see Knox Webhook Notification for Knox Device Management Service.

Get devices

Use the POST /devices/getDevices operation to retrieve a list of uploaded devices based on specified search filters. In the request header, add the Authorization parameter with value Bearer <your-oauth2.0-access-token> to authenticate your request.

You can filter based on:

  • Upload ID, which is the operation ID of the /upload operation which uploaded these devices.
  • A list of IMEIs or serial numbers of the devices you want to retrieve.

You can paginate through the list of returned devices with the searchAfter and pageSize parameters. pageSize determines the size of a single page of the device list, and you can navigate through pages by providing a device ID in searchAfter, which retrieves the next page of devices listed after the provided device ID.

For each device in the list, you can retrieve device information such as:

  • Device ID
  • Customer ID of the device owner
  • Primary and secondary IMEI
  • Device serial number
  • Device MEID
  • Device model name

Use Knox Asset Intelligence

Now you can use Knox Asset Intelligence on your devices. In this example, we’ll use the Knox Asset Intelligence API to request device diagnostic logs.

You can also use Knox Webhook Notification to receive device diagnostic results once they’re ready. See how to get notifications for Knox Asset Intelligence with Knox Webhook Notification.

Delete devices from Knox Device Management Service

Delete a list of devices with the POST /devices/delete operation in the Knox Device Management Service API. This operation allows you to delete devices with a list of IMEIs or serial numbers.

In the request header, add the Authorization parameter with value Bearer <your-oauth2.0-access-token> to authenticate your request. For details, see Call Knox cloud services APIs with access token.

In the request body, set targetServices to KAI to remove these devices from Knox Asset Intelligence.

You can subscribe to Knox Webhook Notification with the KDMS_DEVICE_DELETE event to receive notifications once the asynchronous device delete operation is complete. For more information, see Knox Webhook Notification for Knox Device Management Service.

Is this page helpful?