Roles.GetRolesForUser Method (String)


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

Gets a list of the roles that a user is in.

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

public static string[] GetRolesForUser(
	string username


Type: System.String

The user to return a list of roles for.

Return Value

Type: System.String[]

A string array containing the names of all the roles that the specified user is in.

Exception Condition

username is null.


username contains a comma (,).


Role management is not enabled.

The GetRolesForUser method calls the RoleProvider.GetRolesForUser method of the default role provider to retrieve from the data source the roles that the user is in. Only the roles for the application that is specified in the ApplicationName property are retrieved.

If username is equal to the current logged-on user and CacheRolesInCookie is true, the results of the GetRolesForUser method may be returned from the role cache rather than the specified Provider.

The following code example uses the GetRolesForUser method to retrieve a list of roles for a specified user and bind the returned roles to a System.Web.UI.WebControls.GridView control. For an example of a Web.config file that enables role management, see Roles.

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

string[] rolesArray;

public void Page_Load()
  if (!IsPostBack)
    // Bind roles to GridView.

      rolesArray = Roles.GetRolesForUser();
    catch (HttpException e)
      Msg.Text = "There is no current logged on user. Role information cannot be retrieved.";

    UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name;
    UserRolesGrid.DataSource = rolesArray;

<html xmlns="" >
<title>Sample: View User Roles</title>

<form runat="server" id="PageForm">

  <h3>View User Roles</h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table border="0" cellspacing="4">
      <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" 
                                     AutoGenerateColumns="false" Gridlines="None" 
                                     CellSpacing="0" >
                         <HeaderStyle BackColor="navy" ForeColor="white" />
                           <asp:TemplateField HeaderText="Roles" >
                               <%# Container.DataItem.ToString() %>



.NET Framework
Available since 2.0
Return to top