Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
User Management

Update user information using userID

Use this API to update username and profile of an existing user.

patch/usermanagement/v1/users/{userID}

Path parameters

userIDinteger required

Specify the inSync user ID of the user for whom you want to update the username or profile. Get the ID of a user using the ‘List all users’ API.

Request body

userNamestring

Specify the new username for the user.

profileIDinteger

Specify the ID of the new profile that you want to associate with the user account. The new profile settings are applied to the user account in the next backup cycle.Get the profile ID using the 'List all profiles' API. :fa-info-circle: If you are changing user's profile to a profile where the Privacy Settings conflicts with the Privacy Settings in the old profile, which may result in administrators getting an unintentional access to the user's data, inSync does not allow you to update the profile. In such a case, you must request the inSync user to allow the inSync administrators to access their backed up data (setting on inSync Client) and try again.

Example request

{
  "userName": "Ernie Carter",
  "profileID": 2
}

Response

OK

userIDinteger

The unique id of the user in Druva inSync. Example - 1

userNamestring

The user name of the user in Druva inSync. Example - Ernie Carter

emailIDstring

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

status'active' | 'preserved'

The status of the user account. Example - active

profileIDinteger

The profile ID of the profile associated with the user. Example - 1

storageIDinteger

The storage ID of the storage associated with the user. Example - 1

quotastring

The storage quota assigned to the user in inSync. Example - 50 GB

quotaInBytesinteger

The storage quota (in bytes) assigned to the user in inSync. Example - 53687091200

addedOnstring date-time

The date on which the user was added in inSync. Example - 2019-10-25T00:00:00Z

Example response

{
  "userID": 1,
  "userName": "Ernie Carter",
  "emailID": "ernie.carter@druva.com",
  "profileID": 1,
  "storageID": 1,
  "quota": "50 GB",
  "quotaInBytes": 53687091200,
  "addedOn": "2019-10-25T00:00:00Z"
}