Get Domain Groups

API Type

Web Services

Description

Retrieves all the domain group objects.

Syntax

public virtual KeyValue[] GetDomainGroups(string LDAPPath, string Filter)

Parameters

Name	Description
LDAPPath	Definition: The LDAP path to the domain. Type string Allowed Values: A valid LDAP path. If the value is null, the AgilePoint Server machine domain will be used.
Filter	Definition: A filter term for groups that is wildcard-enabled. Type string Allowed Values: A string in the format (name=[my wildcard filter]).

Output

Array of KeyValue objects. If the specified group is not found, the output is null.

Example

IWFAdminService svc = GetAdminService();
string LDAPPath = ...// for example, LDAP://ou=Sales,dc=Frabrikam,dc=com
string Filter = "A*";
Filter = string.Format("(name={0})", Filter);

try
	{
    KeyValue[] grps = svc.GetDomainGroups(LDAPPath, Filter);
 foreach (KeyValue grp in grps)
        {
        Console.WriteLine("Group Name:{0}; Group Distinct Name:{1};", grp.Key, grp.Value);
        }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 and higher