Search Group

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

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

Request parameters:

Following are the request parameters that can be used while searching for an AD group:

Parameter name	Mandatory	Description
domainName	Yes	Domain where the group is located.
AuthToken	Yes	Authentication Token obtained using the Generate AuthToken API.
RANGE	Yes	Number of group details to be returned in the response.
FROM_INDEX	Yes	Starting index for the group details result.
searchText	Yes	Text that must be used to search the group.
PRODUCT_NAME	Yes	Product name/module name from which the request is being sent; will be needed for auditing.
refresh	No	Server will be refreshed to update the changes made to AD groups in ADManager Plus.
isPrimaryGroup	No	Lists the global security groups in the domain.

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
GROUP_NAME	Name of the group.
DISTINGUISHED_NAME	Distinguished name of the group.
SAM_ACCOUNT_NAME	sAMAccountName of the group.

Sample request format:

http://Byron:8080/RestAPI/SearchGroup?AuthToken=ec090943-a2ec-4bef-bf91-eca30fa09838&domainName=division.com&RANGE=100&FROM_INDEX=1&searchText=Department&PRODUCT_NAME=MODULE&isPrimaryGroup=true

Sample response format:

[
    {
        "GROUP_NAME": "Finance Department",
        "DISTINGUISHED_NAME": "CN=Finance Department,CN=Users,DC=division,DC=com",
        "SAM_ACCOUNT_NAME": "Finance Department"
    },
    {
        "GROUP_NAME": "Production Department",
        "DISTINGUISHED_NAME": "CN=Production Department,CN=Users,DC=division,DC=com",
        "SAM_ACCOUNT_NAME": "Production Department"
    },
    {
        "GROUP_NAME": "Marketing Department",
        "DISTINGUISHED_NAME": "CN=Marketing Department,OU=Finance-OU,DC=division,DC=com",
        "SAM_ACCOUNT_NAME": "Marketing Department"
    },
    {
        "GROUP_NAME": "Account Operators",
        "DISTINGUISHED_NAME": "CN=Account Operators,OU=Finance-OU,DC=division,DC=com",
        "SAM_ACCOUNT_NAME": "Account Operators"
    },
    {
        "GROUP_NAME": "Administrators",
        "DISTINGUISHED_NAME": "CN=Administrators,OU=HR,DC=division,DC=com",
        "SAM_ACCOUNT_NAME": "Administrators"
    }
]

Search Group

ADManager Plus Trusted By