Get Domain Group Members

API Type

Web Services

Description

Retrieves the members of a group in the Active Directory domain.

Good to Know

  • This method is used only for AgilePoint internal purposes.
  • The distinguished name of the group in the LDAP format is required in the groupDistinguishedName parameter.

Syntax

public virtual DomainUser[] GetDomainGroupMembers(string groupDistinguishedName)

Parameters

NameDescription

groupDistinguishedName
Description:
Specifies the name of a group in LDAP format.
Type
string
Allowed Values:
A valid a group name in LDAP format.

Output

An array of DomainUser objects.

Example

IWFAdminService svc = GetAdminService();
string groupName = "Administrators";
string groupDistinguishedName = "LDAP://" + groupName;

try
	{
    DomainUser[] grpUsers = svc.
    GetDomainGroupMembers(groupDistinguishedName);
    foreach (DomainUser usr in grpUsers)
        {
        Console.WriteLine("User Name:{0}; Full Name:{1};", usr.UserName, usr.FullName);
        }
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}
/*
This example produces the following results:
User Name:Administrator; Full Name:Administrator
User Name:vitbdc/yuvarajn; Full Name:Yuvaraj Nagarajan
*/

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.