PingDirectory API Reference

Soft deleted entry access request control

This control can be included in a search request to show soft-deleted entries in the search results. Learn more about soft deletes in Soft delete request control.

The _controls array must include the value-json attribute with the following values:

  • include-non-soft-deleted-entries: A mandatory boolean specifying whether entries which have not been soft-deleted will be included in search results if they meet the criteria.

  • return-entries-in-undeleted-form: A mandatory boolean specifying whether soft-deleted entries returned in search results will display as if they were undeleted (the entryUUID will not be included in the DN, and the entry won’t be given the ds-soft-delete-entry object class).

The following example shows the JSON encoding for the control:

{
    "oid":"1.3.6.1.4.1.30221.2.5.20",
    "control-name":"Soft-Deleted Entry Access Request Control",
    "criticality":true,
    "value-json":
    {
        "return-soft-delete-response-control":true
    }
}