User Device Management (UDM)
The User Device Management (UDM) module provides functionality to manage and track user devices, including registration, monitoring, and removal of devices.
Table of Contents
registerDevice
getLinkDevices
getLinkDevice
updateLastOnline
updateDeviceName
removeDevice
getLinkDevicesHistory
Methods
registerDevice
Registers a new device with the system.
Parameters:
body: ARegisterDeviceRequestobject containing:uniqueId: The unique identifier of the deviceuniqueIdType: The type of unique identifier ( "uuid", "imei")label: The device labeltype: The device type ("mobile", "cloud", "browser")customName: The custom name of the deviceos: The operating system versionbrowserName: The browser name (if applicable)
getLinkDevices
Retrieves a list of all linked devices for the current user.
getLinkDevice
Retrieves details of a specific linked device.
Parameters:
uniqueId: The unique identifier of the device
updateLastOnline
Updates the last online timestamp for a specific device.
Parameters:
uniqueId: The unique identifier of the device
updateDeviceName
Updates the display name of a specific device.
Parameters:
uniqueId: The unique identifier of the devicename: The new name for the device
removeDevice
Removes a device from the linked devices list.
Parameters:
uniqueId: The unique identifier of the device
getLinkDevicesHistory
Retrieves the history of device linking and unlinking events.
Complete Example
Here's a complete example of how to use the UDM features:
Last updated