Add Group Member

Description

Adds a user as a member of a group.

Syntax

public virtual WFGroupMember AddGroupMember(string groupName, string userName, string description, string clientData, bool enabled)

Parameters

Name	Type	Description
groupName	string	A string that contains the name of the group.
userName	string	A string that contains the user name for the user. This member must be a registered AgilePoint user.
description	string	A string that contains the description of an entity.
clientData	string	A string that contains the client data. If clientData is null, the system will keep existing client data, otherwise the relevant data would be overwritten.
enabled	bool	A Boolean value: True enables the entity; False disables the entity.

Output

WFGroupMember object that contains the data for the new group member.

Example

IWFAdminService svc = GetAdminService();
string groupName = ...;
string description = ...;
string userName = @"[Domain Name]\[Account Name]", // Group Lead User Name
string clientData = null;
bool enable = true;

try
    {
    WFGroup group = svc.AddGroupMember(groupName, userName, description,
    clientData, enable);
    }

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

Supported Versions

3.2.0.4 and higher