SqlRoleProvider Class

Definition

Namespace:

System.Web.Security

Assembly:

System.Web.dll

Manages storage of role membership information for an ASP.NET application in a SQL Server database.

public ref class SqlRoleProvider : System::Web::Security::RoleProvider

public class SqlRoleProvider : System.Web.Security.RoleProvider

type SqlRoleProvider = class
    inherit RoleProvider

Public Class SqlRoleProvider
Inherits RoleProvider

Inheritance

Object

ProviderBase

RoleProvider

SqlRoleProvider

Examples

The following example shows the Web.config file for an ASP.NET application configured to use a SqlRoleProvider object and the SqlMembershipProvider. The authorization element is configured to only allow access to authenticated users in the Administrators role.

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=localhost;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>
  <system.web>
    <authentication mode="Forms" >
      <forms loginUrl="logincs.aspx"
      name=".ASPXFORMSAUTH" />
    </authentication>
    <authorization>
      <deny users="?" />
      <allow roles="Administrators" />
      <deny users="*" />
    </authorization>
    <membership defaultProvider="SqlProvider" userIsOnlineTimeWindow="15">
      <providers>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlMembershipProvider"
          connectionStringName="SqlServices"
          enablePasswordRetrieval="false"
          enablePasswordReset="false"
          requiresQuestionAndAnswer="false"
          passwordFormat="Hashed"
          applicationName="SampleApplication" />
      </providers>
    </membership>
    <roleManager defaultProvider="SqlProvider"
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="true"
      cookieSlidingExpiration="true"
      cookieProtection="All" >
      <providers>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices"
          applicationName="SampleApplication" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

Remarks

This class is used by the Roles and RolePrincipal classes to provide role-management services for an ASP.NET application using a SQL Server database. You can use role management to specify different levels of authorization for your application.

To use the SqlRoleProvider class, you must first create the SQL Server database used by the SqlRoleProvider. To create the database used by the SqlRoleProvider class, run the aspnet_regsql.exe executable found in the C:\WINDOWS\Microsoft.NET\Framework\ versionNumber folder and specify the -Ar option (for example, aspnet_regsql.exe -Ar). The database created is called Aspnetdb. Alternatively, run aspnet_regsql.exe to pull up the GUI configuration mode and choose to configure all ASP.NET features.

If the role provider is configured with a connection string that uses integrated security, the process account of the ASP.NET application must have rights to connect to the SQL Server database.

The Machine.config file is configured with a SqlRoleProvider instance named AspNetSqlProvider that connects to the SQL Server on the local machine. You can use this instance of the provider, or specify your own in the Web.config file for your ASP.NET application. To use the AspNetSqlProvider instance, specify AspNetSqlProvider as the defaultProvider in your configuration.

You can configure the SqlRoleProvider to use the same database and user information as the SqlMembershipProvider in order to use a single database for authentication and authorization information. To use the same database for membership and role information, run the aspnet_regsql.exe executable and install the membership feature. Then, specify the same connection string in your configuration for both your SqlRoleProvider and SqlMembershipProvider instances. Also ensure that both provider instances are configured with the same ApplicationName.

Constructors

SqlRoleProvider()

Creates an instance of the SqlRoleProvider class.

Properties

ApplicationName	Gets or sets the name of the application for which to store and retrieve role information.
Description	Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). (Inherited from ProviderBase)
Name	Gets the friendly name used to refer to the provider during configuration. (Inherited from ProviderBase)

Methods

AddUsersToRoles(String[], String[])	Adds the specified user names to each of the specified roles.
CreateRole(String)	Adds a new role to the role database.
DeleteRole(String, Boolean)	Removes a role from the role database.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindUsersInRole(String, String)	Gets an array of user names in a role where the user name contains the specified user name to match.
GetAllRoles()	Gets a list of all the roles for the application.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRolesForUser(String)	Gets a list of the roles that a user is in.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUsersInRole(String)	Gets a list of users in the specified role.
Initialize(String, NameValueCollection)	Initializes the SQL Server role provider with the property values specified in the ASP.NET application's configuration file. This method is not intended to be used directly from your code.
IsUserInRole(String, String)	Gets a value indicating whether the specified user is in the specified role.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RemoveUsersFromRoles(String[], String[])	Removes the specified user names from the specified roles.
RoleExists(String)	Gets a value indicating whether the specified role name already exists in the role database.
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• Understanding ASP.NET Role Management