Roles.RemoveUsersFromRoles Method (String[], String[])


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Removes the specified user names from the specified roles.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

public static void RemoveUsersFromRoles(
	string[] usernames,
	string[] roleNames


Type: System.String[]

A string array of user names to remove from the specified roles.

Type: System.String[]

A string array of role names to remove the specified users from.

Exception Condition

One of the roles specified in roleNames is null.


One of the users specified in usernames is null.


One of the roles specified in roleNames is an empty string or contains a comma (,).


One of the users specified in usernames is an empty string or contains a comma (,).


roleNames contains a duplicate element.


usernames contains a duplicate element.


Role management is not enabled.

The RemoveUsersFromRoles method calls the default role provider to remove the specified users from the specified roles at the data source.

If the application uses the SqlRoleProvider class, the database updates that are performed during the call to the RemoveUsersFromRoles method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed.

The following code example uses the RemoveUsersFromRoles method to remove one or more users from one or more roles based on user input. For an example of a Web.config file that enables role management, see Roles.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Web.UI" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

string[] rolesArray;
MembershipUserCollection users;

public void Page_Load()
  Msg.Text = "";

  if (!IsPostBack)
    // Bind roles to ListBox.

    rolesArray = Roles.GetAllRoles();
    RolesListBox.DataSource = rolesArray;

    // Bind users to ListBox.

    users = Membership.GetAllUsers();
    UsersListBox.DataSource = users;

public void RemoveUsers_OnClick(object sender, EventArgs args)
  // Verify that at least one user and one role are selected.

  int[] user_indices = UsersListBox.GetSelectedIndices();

  if (user_indices.Length == 0)
    Msg.Text = "Please select one or more users.";

  int[] role_indices = RolesListBox.GetSelectedIndices();

  if (role_indices.Length == 0)
    Msg.Text = "Please select one or more roles.";

  // Create list of users to be removed from the selected roles.

  string[] usersList = new string[user_indices.Length];

  for (int i = 0; i < usersList.Length; i++)
    usersList[i] = UsersListBox.Items[user_indices[i]].Value;

  // Create list of roles to be remove the selected users from.

  string[] rolesList = new string[role_indices.Length];

  for (int i = 0; i < rolesList.Length; i++)
    rolesList[i] = RolesListBox.Items[role_indices[i]].Value;

  // Remove the users from the selected roles.

    Roles.RemoveUsersFromRoles(usersList, rolesList);  
    Msg.Text = "User(s) removed from Role(s).";
  catch (HttpException e)
    Msg.Text = e.Message;

<html xmlns="" >
<title>Sample: Role Membership</title>

<form runat="server" id="PageForm">
  <h3>Role Membership</h3>
  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />
  <table cellpadding="3" border="0">
      <td valign="top">Roles:</td>
      <td valign="top"><asp:ListBox id="RolesListBox" runat="server" SelectionMode="Multiple"
                                    Rows="8" /></td>
      <td valign="top">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                  Rows="8" SelectionMode="Multiple" runat="server" /></td>
      <td valign="top"><asp:Button Text="Remove User(s) from Role(s)" id="RemoveUsersButton"
                                 runat="server" OnClick="RemoveUsers_OnClick" /></td>


.NET Framework
Available since 2.0
Return to top