Roles.AddUserToRole Method (String, String)


Adds the specified user to the specified role.

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

public static void AddUserToRole(
	string username,
	string roleName


Type: System.String

The user name to add to the specified role.

Type: System.String

The role to add the specified user name to.

Exception Condition

roleName is null.


username is null.


roleName is an empty string or contains a comma (,).


username is an empty string or contains a comma (,).


Role management is not enabled.


User is already assigned to the specified role.

The AddUserToRole method calls the default role provider to associate the specified user with the specified role at the data source.


User names and role names cannot contain commas.

The following code example adds a user to a role. 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 AddUser_OnClick(object sender, EventArgs args)
  // Verify that a user and a role are selected.

  if (UsersListBox.SelectedItem == null)
    Msg.Text = "Please select a user.";

  if (RolesListBox.SelectedItem == null)
    Msg.Text = "Please select a role.";

  // Add the user to the selected role.

    Roles.AddUserToRole(UsersListBox.SelectedItem.Value, RolesListBox.SelectedItem.Value);  
    Msg.Text = "User added to Role.";
  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" Rows="8" /></td>
      <td valign="top">Users:</td>
      <td valign="top"><asp:ListBox id="UsersListBox" DataTextField="Username" 
                                  Rows="8" runat="server" /></td>
      <td valign="top"><asp:Button Text="Add User to Role" id="AddUserButton"
                                 runat="server" OnClick="AddUser_OnClick" /></td>


.NET Framework
Available since 2.0
Return to top