--- updatedAt: 2026-06-02T08:41:39.000Z agentTools: projectIndex: https://developer.druva.com/llms.txt --- # List all users Returns the list of users in Druva inSync with their details. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "3.0", "title": "inSync Cloud" }, "tags": [ { "name": "User Management", "description": "Lists the APIs to get information and perform operations on users managed in Druva inSync." } ], "paths": { "/usermanagement/v1/users": { "get": { "tags": [ "User Management" ], "summary": "List all users", "description": "Returns the list of users in Druva inSync with their details.", "security": [ { "Bearer": [] } ], "parameters": [ { "name": "profileID", "in": "query", "description": "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.", "required": false, "schema": { "type": "integer" } }, { "name": "storageID", "in": "query", "description": "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.", "required": false, "schema": { "type": "integer" } }, { "name": "cacheID", "in": "query", "description": "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.", "required": false, "schema": { "type": "integer" } }, { "name": "userIDs", "in": "query", "description": "Specify unique user IDs, separated by commas, to get details of specific users.", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "emailID", "in": "query", "description": "Specify the email address to list a user's details.", "required": false, "schema": { "type": "string" } }, { "name": "searchPrefixEmailID", "in": "query", "description": "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.", "required": false, "schema": { "type": "string" } }, { "name": "searchPrefixUserName", "in": "query", "description": "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'.", "required": false, "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.", "required": false, "schema": { "type": "string" } }, { "name": "minAddedOn", "in": "query", "description": "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", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "maxAddedOn", "in": "query", "description": "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", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "description": "Specify the current status of user account to filter and list the users.", "required": false, "schema": { "type": "string", "enum": [ "active", "preserved" ] } }, { "name": "ldapGUID", "in": "query", "description": "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", "required": false, "schema": { "type": "string" } }, { "name": "privacySettingsEnabled", "in": "query", "required": false, "description": "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.", "schema": { "type": "boolean", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserList" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "The request did not include an authentication token or an expired authentication token was supplied." }, "403": { "description": "Access denied: Insufficient permissions. User requires specific access rights and minimum permissions. Details: https://help.druva.com/en/articles/15069296", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_403" } } } }, "404": { "description": "The requested resource was not found." }, "500": { "description": "The request was not processed due to an internal error in inSync Cloud.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "501": { "description": "Requested HTTP method is not implemented.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "servers": [ { "url": "https://apis.druva.com/insync" } ], "components": { "securitySchemes": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "User": { "type": "object", "properties": { "userID": { "type": "integer", "format": "int64", "description": "The unique id of the user in inSync. Example - 1", "example": 1 }, "userName": { "type": "string", "description": "The username of the user in inSync. Example - Ernie Carter", "example": "Ernie Carter" }, "emailID": { "type": "string", "description": "The email address of the user. Example - ernie.carter@druva.com", "example": "ernie.carter@druva.com" }, "status": { "type": "string", "description": "The status of the user account. Example - active", "enum": [ "active", "preserved" ] }, "profileID": { "type": "integer", "description": "The profile ID of the profile associated with the user. Example - 1", "example": 1 }, "storageID": { "type": "integer", "description": "The storage ID of the storage associated with the user. Example - 1", "example": 1 }, "cacheID": { "type": "integer", "description": "The CloudCache Server ID associated with the user. Example - 1", "example": 1 }, "quota": { "type": "string", "description": "The storage quota assigned to the user in inSync. Example - 10 GB", "example": "10 GB" }, "quotaInBytes": { "type": "integer", "description": "The storage quota assigned to the user (in bytes) in inSync. Example - 10737418240", "example": 10737418240 }, "addedOn": { "type": "string", "format": "date-time", "description": "The date on which the user was added in inSync. Example - 2019-10-25T00:00:00Z", "example": "2019-10-25T00:00:00Z" }, "privacySettingsEnabled": { "type": "string", "description": "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.", "example": true }, "ldapGUID": { "type": "boolean", "format": "hexstring", "description": "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.", "example": "B1C47201C67910458867BA19982E353E" }, "additionalProperties": { "type": "object", "description": "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.", "additionalProperties": { "type": "string" }, "example": { "userIdentifierCustomAttribute": "Custom Attribute Label", "userIdentifierCustomAttributeValue": "Custom Attribute Value" } } } }, "UserList": { "type": "object", "properties": { "totalSize": { "type": "integer", "format": "int64", "description": "The total number of users fetched based on applied filters.", "example": 1 }, "nextPageToken": { "type": "string", "description": "The token to access the next page of results. This parameter will be empty for the last page of results.", "example": "MTExMQ==" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "Error": { "type": "object", "properties": { "code": { "type": "string", "example": "InsyncEndpoints-1006", "description": "Application specific error code" }, "message": { "type": "string", "example": "Internal server error", "description": "Application specific error message" }, "retryable": { "type": "boolean", "default": false, "description": "If true, retry using exponential backoff" }, "data": { "type": "object", "description": "Dictionary of values present in the error message for localization. Currently, no values are available." } } }, "HTTP_403": { "type": "object", "properties": { "code": { "type": "string", "example": "InsyncAdmanagement-1221", "description": "Application specific error code" }, "message": { "type": "string", "example": "Access restricted due to insufficient permissions.", "description": "Application specific error message" }, "retryable": { "type": "boolean", "example": false, "description": "If true, retry using exponential backoff" }, "data": { "type": "object", "description": "Dictionary of values present in the error message for localization. Currently, no values are available." } } } } } } ```