Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Endpoints

Create device mapping

Creates a secure user-to-device mapping to perform a mass deployment in a non-AD/LDAP environment or perform bulk replace of devices. The user-to-device mapping ensures controlled device and user activation of inSync client and prevents addition of rogue or unauthorized devices to inSync.

post/endpoints/v1/devicemappings

Request body

emailIDstring required

Specify the email address of the user. Example - ernie.carter@druva.com

userNamestring required

Specify the username of the user in Druva inSync. Example - Ernie Carter

deviceNamestring required

Specify the name of the device that is registered with the user. Example - Ernie Carter's Macbook

deviceIdentifierType'serial-number' | 'uuid' | 'hostname' required

Specify the unique device identifier type of the device.(serial-number, uuid, or hostname)

deviceIdentifierstring required

Specify the unique device identifier for the selected type. (serial-number, uuid, or hostname).

oldDeviceNamestring

Name of the user's old device in Druva inSync that is to be replaced with a new device.

:fa-info-circle: Note: Specify the value for this parameter only if you want to replace the device for the user, else keep this field blank.

restoreData'ALL' | 'DATA' | 'SYSTEM'

The type of data restore to be performed.(ALL, SYSTEM, OR DATA) Type of data to be restored on the new device.Specify one of the following value:

  1. All - To restore both, the data and the system settings from the existing device on the new device.
  2. SYSTEM - To restore only the system settings from the existing device on the new device. 3)DATA - To restore only the data from the existing device on the new device.

:fa-info-circle: Note: Specify the value for this parameter only if you want to replace the device for the user, else keep this field blank.

Example request

{
  "emailID": "ernie.carter@druva.com",
  "userName": "Ernie Carter",
  "deviceName": "ErnieCarter's Macbook",
  "deviceIdentifierType": "serial-number",
  "deviceIdentifier": "P0XGGGH",
  "oldDeviceName": "ErnieCarter's Old Macbook",
  "restoreData": "SYSTEM"
}

Response

OK

mappingIDstring

The id of the device mapping in inSync. Example - 3452rw6

emailIDstring

The email address of the user. Example - ernie.carter@druva.com

userNamestring

The username of the user in inSync. Example - Ernie Carter

deviceNamestring

The device name linked to the user in inSync.

deviceIdentifierTypestring

The unique id type of the device in inSync. Example - Serial Number

deviceIdentifierstring

The unique id of the device in inSync. Example - Po3XF

oldDeviceNamestring

The old device name linked to the user in inSync. Example - Ernie Carter's Old Macbook

restoreDatastring

The type of data restore performed on the new device. Example - SYSTEM

Example response

{
  "mappingID": "3452rw6",
  "emailID": "ernie.carter@druva.com",
  "userName": "Ernie Carter",
  "deviceName": "Ernie Carter's Macbook",
  "deviceIdentifierType": "Serial Number",
  "deviceIdentifier": "Po3XF",
  "oldDeviceName": "Ernie Carter's Old Macbook",
  "restoreData": "SYSTEM"
}