DRdruva
Legal Hold

Remove users (custodians) from a legal hold policy - v4

Remove users from a legal hold policy within Druva inSync. Note that a maximum of 500 email addresses can be processed at a time. Any additional addresses provided beyond this limit will be ignored, and this will be highlighted in the response message.

delete/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 identifier for the legal hold policy where the custodians should be removed.

Request body

emailIDsstring[] required

Email addresses of custodians to add or remove. The list must not be empty. Only the first 500 addresses are processed.

Example request

{
  "emailIDs": [
    "ernie.carter@druva.com",
    "john.doe@druva.com"
  ]
}

Response

OK

usersDeletedstring[]

Email addresses that were removed from the legal hold policy.

usersNotDeletedstring[]

If a user is not currently on legal hold or has previously been removed from it, their email address will be returned in this list when attempting to delete them from a legal hold policy.

notInSyncMailsstring[]

If a user is not a valid inSync user when being removed from a legal hold policy, their email address will be included in this list.

messagestring

Outcome summary. Contains details indicating if any users were previously not on legal hold, along with a notification if the request exceeded the limit and was capped at 500 emails.

Example response

{
  "usersDeleted": [
    "jane.doe@druva.com"
  ],
  "usersNotDeleted": [
    "bob.miller@druva.com"
  ],
  "notInSyncMails": [
    "sam.wilson@someorg.com"
  ],
  "message": "Custodian(s) removed from legal hold successfully."
}

Changes

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