Prune LDAP Users - API

/rest/{version}/users/pruneLdapUsers

Descriptor	Value
HTTP Method	POST
Description	Removes pruned LDAP users from system.
Required Permission	Manage Users
Version Introduced	2.6.2

Request Header Parameters

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.

Request POST Data Parameters

Parameter	Value	Required	Description
activeDirectoryId	String	Yes	Active directory from which users were removed.

Sample Call:

curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'activeDirectoryId=2' http://localhost:8080/threadfix/rest/latest/users/pruneLdapUsers

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Successfully pruned 10 user(s) of LDAP Vanilla Ice from ThreadFix."
}