Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ClientRoleProvider.GetRolesForUser Method

Gets the names of the roles that the specified user belongs to.

Namespace:  System.Web.ClientServices.Providers
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)
public override string[] GetRolesForUser(
	string username


Type: System.String

The name of the user to retrieve roles for.

Return Value

Type: System.String[]
The role names that username belongs to or an empty array if the user is not authenticated.

username is Empty or null.


username is not the user name of the current, authenticated user.

The GetRolesForUser method retrieves role information for the current, authenticated user, which you must specify in the username parameter. You can get the user name through the static Thread.CurrentPrincipal property as follows: Thread.CurrentPrincipal.Identity.Name.

The service provider caches role information about the local file system to avoid unnecessary service calls. For more information, see the ClientRoleProvider class overview.

The following example code demonstrates how to use this method to determine whether the user login has expired before testing role membership. This code assumes that all valid users are associated with one or more roles. In this case, the GetRolesForUser method will not return any roles for a previously-authenticated user whose login has expired. If the user login has expired, this code displays the login dialog box. Otherwise, it calls the IsUserInRole method to determine whether the user is in the "manager" role. The restricted code is in a PerformManagerTask method, which is not provided.

private void AttemptManagerTask()
    System.Security.Principal.IIdentity identity =

    // Return if the authentication type is not "ClientForms". 
    // This indicates that the user is logged out. 
    if (!identity.AuthenticationType.Equals("ClientForms")) return;

        ClientRoleProvider provider =
        String userName = identity.Name;

        // Determine whether the user login has expired by attempting 
        // to retrieve roles from the service. Call the ResetCache method 
        // to ensure that the roles are retrieved from the service. If no  
        // roles are returned, then the login has expired. This assumes  
        // that every valid user has been assigned to one or more roles.
        String[] roles = provider.GetRolesForUser(userName);
        if (roles.Length == 0)
                "Your login has expired. Please log in again to access " +
                "the roles service.", "Attempting to access user roles...");

            // Call ValidateUser with empty strings in order to  
            // display the login dialog box configured as a  
            // credentials provider. 
            if (!System.Web.Security.Membership.ValidateUser(
                String.Empty, String.Empty))
                MessageBox.Show("Unable to authenticate. " +
                    "Cannot retrieve user roles.", "Not logged in",
                    MessageBoxButtons.OK, MessageBoxIcon.Error);

        if (provider.IsUserInRole(userName, "manager"))
    catch (System.Net.WebException)
            "Unable to access the remote service. " +
            "Cannot retrieve user roles.", "Warning",
            MessageBoxButtons.OK, MessageBoxIcon.Warning);

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft. All rights reserved.