v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Add or delete users (custodians) from a legal hold policy - v3

Add or delete users from a legal hold policy in Druva inSync.

post/legalholds/v3/policies/{policyId}/users

Path parameters

policyIdinteger required

Specify the unique ID of the legal hold policy from which you want to add OR delete the custodians.

Request body

action'add' | 'delete'

The action to be performed on the user.

Example request

{
  "custodians": [
    {
      "emailId": "john.doe@someorg.com"
    }
  ],
  "action": "add"
}

Response

OK

Example response

{
  "alreadyOnLegalhold": [
    {
      "emailId": "john.doe@someorg.com"
    }
  ],
  "notOnLegalhold": [
    {
      "emailId": "john.doe_1@someorg.com"
    }
  ],
  "notInsyncUsers": [
    {
      "emailId": "john.doe_2@someorg.com"
    }
  ]
}