Support
 
Phone Live Chat
 
Support
 
US: +1 888 720 9500
US: +1 800 443 6694
Intl: +1 925 924 9500
Aus: +1 800 631 268
UK: 0800 028 6590
CN: +86 400 660 8680

Direct Inward Dialing: +1 408 916 9393

 
 
 
 
 
Delete Group API
 

Delete Group API

Use this API to delete a group in Active Directory (AD) from your application.

Request URL (JSON) format: http://<hostname>:<port>/RestAPI/DeleteGroup

Request parameters:

AD Groups can be deleted using the POST method. Following are the request parameters that can be used in the request:

Parameters Mandatory Description
domainName Yes Domain where the group is located.
AuthToken Yes Authentication Token obtained using the Generate AuthToken API.
inputFormat Yes Details of the group that has to be deleted in AD. This attribute should be JSONArray string and must be specified in this format:
[<JSONObject>,<JSONObject>,<JSONObject>]; JSONObject - key/value pair of LDAP attributes and their corresponding values.
PRODUCT_NAME Yes Product name/module name from which the request is being sent; will be needed for auditing.

Response:

The response will be a JSON array string with a list of JSONObjects. Each JSONObject in the list represents an object sent in the inputFormat attribute in the request. Each object will contain the following properties about the status:

Parameter name Description
sAMAccountName sAMAccountName of the group deleted from your AD.
status Status of the operation.
statusMessage Contains the message about the issues or errors that occur while performing the specified action.

Sample request format:

http://Byron:8080/RestAPI/DeleteGroup?domainName=division-dc1.local&AuthToken=d762fe90-0c13-45cf-81fb-3b60e05bfef2&inputFormat=[{"sAMAccountName": "Accounts Department"},{"sAMAccountName":"Sales Department"}]&PRODUCT_NAME=MODULE

Sample response format:

[
    {
        "sAMAccountName": "Accounts Department",
        "statusMessage": "Successfully Deleted",
        "status": "1"
    },
    {
        "sAMAccountName": "Sales Department",
        "statusMessage": "Successfully Deleted",
        "status": "1"
    }
]
			

ADManager Plus Trusted By

The one-stop solution to Active Directory Management and Reporting
Email Download Link