DRdruva
User Management

Create a new user

Creates a new user in Druva inSync with the settings defined in this API.

post/usermanagement/v1/users

Request

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

Request body

userNamestring required

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

profileIDinteger required

Specify the ID of the profile to be associated with the user account. Get the ID of a profile using the 'List all profiles' API.

storageIDinteger required

Specify the ID of the storage on which the user data backed up by inSync should be stored. Get the ID of a storage using the 'List all storages' API.

emailIDstring required

Specify the email address of the user.

quotainteger

Specify the storage quota that should be allocated to the new user. Specify a value between 0 to 1023. Example - 1000
:fa-info-circle: If kept blank, the storage quota configured in the profile is assigned to the user.

quotaUnit'MB' | 'GB' | 'TB'

Specify the storage unit for the quota value (MB,GB, OR TB).

sendPasswordByEmailboolean

Specify whether to send the password to the user by email. If false, password is not sent to the user. Default is true and password will be sent to the user's email address.

Example request

{
  "userName": "Ernie Carter",
  "profileID": 2,
  "storageID": 2,
  "emailID": "ernie.carter@druva.com",
  "sendPasswordByEmail": true
}

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.