Add Group Member

API Type

Web Services

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	Description
GroupName	Definition: Specifies the name of a group. Type string Allowed Values: A valid group name.
UserName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.
Description	Definition: A free text description of an entity. Type string Allowed Values: A string that can contain spaces and special characters.
ClientData	Definition: Specifies the client data, which identifies a client for AgilePoint Server. Type string Allowed Values: A string that contains the client data. If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.
Enabled	Definition: Enables or disables an entity. Type bool Allowed Values: 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 Enabled = true;

try
    {
    WFGroup group = svc.AddGroupMember(GroupName, UserName, Description,
    ClientData, Enabled);
    }

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

Supported Versions

3.2.0.4 and higher