DRdruva
User Management

Update user information using userID

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

patch/usermanagement/v1/users/{userID}

Request

  • Base URL
    https://apis.druva.com/insync
  • URL
    https://apis.druva.com/insync/usermanagement/v1/users/{userID}
  • Auth
    API key in header Authorization

Path parameters

userIDinteger required

Specify the inSync user ID of the user for whom you want to update the username, profile, or storage region. 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.

storageIDinteger

Specify the ID of the new storage that you want to associate with the user account.Get the storage ID using the 'List all storages' API. After you change the user's storage: 1)User data is backed up to the new storage. 2)Snapshots on the old storage are retained and compacted following the retention policy. 3) User can restore data from snapshots saved on old as well as the new storage.

Example request

{
  "userName": "Ernie Carter",
  "profileID": 2,
  "storageID": 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

privacySettingsEnabledstring

Displays the status of the privacy setting of the user. If the value returned is True, privacy setting is enabled by the user. If the value returned is False, privacy settings is not set or user has allowed admin access to their data.

ldapGUIDboolean

The AD or LDAP object GUID of the user in a hex string format. Example: B1C47201C67910458867BA19982E353E. The ldapGUID displays objectGUID if the user is imported from AD and displays entryUUID if imported from LDAP.

additionalPropertiesobject

Contains the two keys of userIdentifierCustomAttribute and userIdentifierCustomAttributeValue if the User-Identifier Custom Attribute feature is enabled for the account and the administrator has opted to display it on the inSync UI. This field remains empty if the administrator has opted to hide the User-Identifier Custom Attribute.

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",
  "additionalProperties": {
    "userIdentifierCustomAttribute": "Custom Attribute Label",
    "userIdentifierCustomAttributeValue": "Custom Attribute Value"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.