Remove Role Member

API Type

Web Services

Description

Removes a user or a group from a specified role.

Syntax

public virtual void RemoveRoleMember(string RoleName, string Assignee, string AssigneeType, string ObjectID)

Parameters

Name	Description
RoleName	Definition: The name of a role. Type string Allowed Values: A valid role name.
Assignee	Definition: The name of the assignee. Type string Allowed Values: A valid user name or group name, depending upon the assignee type.
AssigneeType	Definition: The type for the assignee for the task. Type string Allowed Values: User - Assigns the task to a user. Group - Assigns the task to a group.
ObjectID	Definition: Reserved for future use. Type string Allowed Values: A null value.

Output

None.

Example

IWFAdminService svc = GetAdminService();
string RoleName = ...// for example, "Engineers"
string Assignee = ...// for example, @"VIT\ct-002"

try
	{
    svc.RemoveRoleMember(RoleName, Assignee, "User", null);
	}

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

Supported Versions

3.2.0.4 and higher