DRdruva
Legal Hold

Lists the users of a Legal Hold policy - v4

Returns the list of users who are a part of Legal Hold.

get/legalholds/v4/policies/{policyId}/users

Request

  • Base URL
    https://apis.druva.com/insync
  • URL
    https://apis.druva.com/insync/legalholds/v4/policies/{policyId}/users
  • Auth
    API key in header Authorization

Path parameters

policyIdinteger required

Specify the unique ID of the Legal Hold policy for which you want the list of users. Get the ID of a Legal Hold policy using the 'List Legal Hold policies' API. Example - 12529

Query parameters

pageNumberinteger

Search users according to the page number. Example-1.

pageSizeinteger

Search users according to the page size. The maximum page size should not exceed 500. Example - 100.

searchPrefixstring

Search users by user name or user's email. Example - john.doe@druva.com

sortBy'name'

Sort to filter the list of users. You can sort the users by user name.

sortOrder'asc' | 'desc'

Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.

Response

OK

Example response

{
  "results": {
    "usersList": [
      {
        "userName": "John Doe",
        "status": "Active",
        "userEmail": "john@druva.org",
        "collectedData": "1.68 GB",
        "collectedDataInBytes": 1800010372,
        "userId": 3,
        "policyId": 12529,
        "onLegalHold": true,
        "numberOfDataSources": 2,
        "totalCollectedData": "2.12 GB"
      }
    ],
    "totalCustodians": 1
  },
  "pageInfo": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 100
  }
}

Changes

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