Enabled Group Member

API Type

Web Services

Description

Enables or disables a user as a member of a group.

Syntax

public virtual WFGroupMember EnabledGroupMember(string GroupName, string userName, 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.

Enabled

Definition:
Enables or disables an entity.
Type
bool
Allowed Values:
  • True - Enables the entity.
  • False - Disables the entity.

Output

WFGroupMember object.

Example

IWFAdminService svc = GetAdminService();                              

string GroupName = "Administrative";
string userName = @"Demo3\Administrator";
bool Enabled =false;

try
	{
    svc.EnabledGroupMember(GroupName, userName, Enabled);
	}

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

Supported Versions

3.2.0.4 and higher