Get Domain Groups

API Type

Web Services

Description

Retrieves all the groups in the Active Directory domain specified in the LDAPPath parameter.

Good to Know

  • This method is used only for AgilePoint internal purposes.

Syntax

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

Parameters

Name Description

LDAPPath
Function:
The LDAP path to the domain.
Type
string
Accepted Values:
A valid LDAP path.

If the value is null, the AgilePoint Server machine domain will be used.

Filter
Function:
A filter term for groups that is wildcard-enabled.
Type
string
Accepted 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

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.