Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
User Management

List all users

Returns the list of users in Druva inSync with their details.

get/usermanagement/v1/users

Query parameters

profileIDinteger

Specify the profile ID to filter and get the list of users associated with a profile. Get the ID of a profile using the 'List all profiles' API.

storageIDinteger

Specify the storage ID to filter and get the list of users associated with a particular storage. Get the ID of a storage using the 'List all storages' API.

cacheIDinteger

Specify the CloudCache Server ID to get the list of users associated with a CloudCache Server. Get the ID of a CloudCache Server using the 'List all CloudCache Servers' API.

userIDsinteger[]

Specify unique user IDs, separated by commas, to get details of specific users.

emailIDstring

Specify the email address to list a user's details.

searchPrefixEmailIDstring

Specify the email prefix by which you intend to search and list the users. Example - In the email address 'ernie.carter@druva.com', 'ernie.carter' is the email prefix.

searchPrefixUserNamestring

Specify the prefix from the user name by which you intend to search and list the users. Example, 'Ern' can be a prefix in the user name 'Ernie'.

pageTokenstring

The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.

minAddedOnstring date-time

Specify the date and time to list users that are added to Druva inSync after it. The time should be specified in the UTC time zone. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ

maxAddedOnstring date-time

Specify the date and time to list users that are added to Druva inSync before it. he time should be specified in the UTC time zone. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ

status'active' | 'preserved'

Specify the current status of user account to filter and list the users.

ldapGUIDstring

Specify the AD or LDAP object GUID to get the list of users associated with it. Pass the parameter as a hex string. Example: B1C47201C67910458867BA19982E353E

privacySettingsEnabledboolean

List users based on the status of their privacy settings. For example, if you select True, all the users with their privacy setting enabled are listed.

Response

OK

totalSizeinteger

The total number of users listed in the result pages.

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of results.

Example response

{
  "totalSize": 1,
  "nextPageToken": "MTExMQ==",
  "users": [
    {
      "userID": 1,
      "userName": "Ernie Carter",
      "emailID": "ernie.carter@druva.com",
      "profileID": 1,
      "storageID": 1,
      "cacheID": 1,
      "quota": "10 GB",
      "quotaInBytes": 10737418240,
      "addedOn": "2019-10-25T00:00:00Z"
    }
  ]
}