Delete OU API

This API enables you to delete any OU from your Active Directory.

Request URL format: http://<hostname>:<port>/RestAPI/DeleteOU

Request parameters:

Parameter name	Mandatory	Description
PRODUCT_NAME	Yes	Product name or module name from which the request is being sent; will be needed for auditing.
AuthToken	Yes	Authentication token that is generated either from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My account tab (My Account > Active Authtokens) in the top right corner of the product.
domainName	Yes	Name of the domain in which the OUs are present.
inputFormat	Yes	Details of each OU to be deleted. This attribute should be a JSONArray string and must be in the format mentioned below: [<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject: The key/value pair of LDAP attributes and the values. Example JSONArray: [{"distinguishedName":"OU=TestOU-1,DC=test ,DC=com"}, {"distinguishedName":"OU=TestOU-2,DC=test,DC=com"}] NOTE: You can specify any of the following attributes as search criteria to locate OU objects using REST API requests: distinguishedName and objectGUID

Response:

The response will be a JSON array string which contains the list of JSONObjects.

Parameter name	Description
name	Name of the OU.
objectGUID	objectGUID of the OU.
distinguishedName	distinguishedName of the OU.
ouName	Name of the container from where the OU is deleted.
statusMessage	Contains the appropriate message if an issue or error occurs while processing the request.
status	Contains 1 or 0, indicating whether the operation is a success or failure.

Sample input/output:

Request

http://admanager:8080/RestAPI/DeleteOU?AuthToken=3187f9d3-da6b-4bc2-aaff-a73495753b8d&PRODUCT_NAME=MODULE_NAME&domainName=test.com&inputFormat=[{"distinguishedName":"OU=TestUsers,DC=test,DC=com"}]

Response:

[
    {
        "name": "TestUsers",
        "objectGUID": "{9DEF43F1-0A2C-464C-8021-48B32E7B21F6}",
        "distinguishedName": "OU=TestUsers,DC=test,DC=com",
        "ouName": "DC=test,DC=com",
        "statusMessage": "Successfully deleted the OU.",
        "status": "1"
    }
]

Technician-based create group limit

The total number of OUs that technicians can delete in a day using the delete OU API depends on the total number of licensed help desk technicians (HDTs) in ADManager Plus.

If an API is used to delete five AD OUs, and three of them are successfully found while two fail, it will be considered as three API calls. The maximum number of API calls an HDT can make is 50/day, irrespective of the tasks the HDT performs. If you have two HDT licenses, the total number of API calls that you can make is 100/day.

As the per day API call limit is not task-specific, you can perform any operation but the total number of API calls should not exceed 100. That is, an HDT can perform a variety of operations like user creation, OU creation, password reset, etc., but the number of API calls for all the tasks put together should not exceed 100.

Note:

The default admin account will not be considered a HDT.
Ensure that you URL encode all the special and reserved characters used in REST API requests. Since the client sending the request (browser, postman or TP tools) does not fall under the purview ADManager Plus, encoding the URL for special, reserved and unsafe characters is solely the users' responsibility.

Reserved characters include ; /? : @ = &
Unsafe characters include < > # % { } | \ ^ ~ [ ] ` "'

Delete OU API

ADManager Plus Trusted By