SqlMembershipProvider Class


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

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

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


public class SqlMembershipProvider : MembershipProvider


Initializes a new instance of the SqlMembershipProvider class.


Gets or sets the name of the application to store and retrieve membership information for.(Overrides MembershipProvider.ApplicationName.)


Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)


Gets a value indicating whether the SQL Server membership provider is configured to allow users to reset their passwords.(Overrides MembershipProvider.EnablePasswordReset.)


Gets a value indicating whether the SQL Server membership provider is configured to allow users to retrieve their passwords.(Overrides MembershipProvider.EnablePasswordRetrieval.)


Gets the number of invalid password or password-answer attempts allowed before the membership user is locked out.(Overrides MembershipProvider.MaxInvalidPasswordAttempts.)


Gets the minimum number of special characters that must be present in a valid password.(Overrides MembershipProvider.MinRequiredNonAlphanumericCharacters.)


Gets the minimum length required for a password.(Overrides MembershipProvider.MinRequiredPasswordLength.)


Gets the friendly name used to refer to the provider during configuration.(Inherited from ProviderBase.)


Gets the time window between which consecutive failed attempts to provide a valid password or password answers are tracked.(Overrides MembershipProvider.PasswordAttemptWindow.)


Gets a value indicating the format for storing passwords in the SQL Server membership database.(Overrides MembershipProvider.PasswordFormat.)


Gets the regular expression used to evaluate a password.(Overrides MembershipProvider.PasswordStrengthRegularExpression.)


Gets a value indicating whether the SQL Server membership provider is configured to require the user to answer a password question for password reset and retrieval.(Overrides MembershipProvider.RequiresQuestionAndAnswer.)


Gets a value indicating whether the SQL Server membership provider is configured to require a unique e-mail address for each user name.(Overrides MembershipProvider.RequiresUniqueEmail.)

System_CAPS_pubmethodChangePassword(String, String, String)
System_CAPS_pubmethodChangePasswordQuestionAndAnswer(String, String, String, String)

Updates the password question and answer for a user in the SQL Server membership database.(Overrides MembershipProvider.ChangePasswordQuestionAndAnswer(String, String, String, String).)

System_CAPS_pubmethodCreateUser(String, String, String, String, String, Boolean, Object, MembershipCreateStatus)

Decrypts an encrypted password.(Inherited from MembershipProvider.)

System_CAPS_pubmethodDeleteUser(String, Boolean)

Removes a user's membership information from the SQL Server membership database.(Overrides MembershipProvider.DeleteUser(String, Boolean).)


Encrypts a password.(Inherited from MembershipProvider.)

System_CAPS_protmethodEncryptPassword(Byte[], MembershipPasswordCompatibilityMode)

Encrypts the specified password using the specified password-compatibility mode.(Inherited from MembershipProvider.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindUsersByEmail(String, Int32, Int32, Int32)

Returns a collection of membership users for which the e-mail address field contains the specified e-mail address.(Overrides MembershipProvider.FindUsersByEmail(String, Int32, Int32, Int32).)

System_CAPS_pubmethodFindUsersByName(String, Int32, Int32, Int32)

Gets a collection of membership users where the user name contains the specified user name to match.(Overrides MembershipProvider.FindUsersByName(String, Int32, Int32, Int32).)


Generates a random password that is at least 14 characters long.

System_CAPS_pubmethodGetAllUsers(Int32, Int32, Int32)

Gets a collection of all the users in the SQL Server membership database.(Overrides MembershipProvider.GetAllUsers(Int32, Int32, Int32).)


Serves as the default hash function. (Inherited from Object.)


Returns the number of users currently accessing the application.(Overrides MembershipProvider.GetNumberOfUsersOnline().)

System_CAPS_pubmethodGetPassword(String, String)

Returns the password for the specified user name from the SQL Server membership database.(Overrides MembershipProvider.GetPassword(String, String).)


Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUser(Object, Boolean)

Gets the information from the data source for the membership user associated with the specified unique identifier and updates the last activity date/time stamp for the user, if specified.(Overrides MembershipProvider.GetUser(Object, Boolean).)

System_CAPS_pubmethodGetUser(String, Boolean)

Returns information from the SQL Server membership database for a user and provides an option to update the last activity date/time stamp for the user.(Overrides MembershipProvider.GetUser(String, Boolean).)


Gets the user name associated with the specified e-mail address.(Overrides MembershipProvider.GetUserNameByEmail(String).)

System_CAPS_pubmethodInitialize(String, NameValueCollection)

Initializes the SQL Server membership 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.(Overrides ProviderBase.Initialize(String, NameValueCollection).)


Creates a shallow copy of the current Object.(Inherited from Object.)


Raises the ValidatingPassword event if an event handler has been defined.(Inherited from MembershipProvider.)

System_CAPS_pubmethodResetPassword(String, String)

Resets a user's password to a new, automatically generated password.(Overrides MembershipProvider.ResetPassword(String, String).)


Returns a string that represents the current object.(Inherited from Object.)


Clears the user's locked-out status so that the membership user can be validated.(Overrides MembershipProvider.UnlockUser(String).)


Updates information about a user in the SQL Server membership database.(Overrides MembershipProvider.UpdateUser(MembershipUser).)

System_CAPS_pubmethodValidateUser(String, String)

Verifies that the specified user name and password exist in the SQL Server membership database.(Overrides MembershipProvider.ValidateUser(String, String).)


Occurs when a user is created, a password is changed, or a password is reset.(Inherited from MembershipProvider.)

This class is used by the Membership and MembershipUser classes to provide membership services for an ASP.NET application using a SQL Server database. You cannot use a SqlMembershipProvider without SQL Server. When your computer has SQL Server Express installed with the default instance name and user-instancing enabled, the SqlMembershipProvider object will create a database called aspnetdb in the application's App_Data directory the first time the application is run.

To manually create the database, run the Aspnet_regsql.exe executable found in the %systemroot%\Microsoft.NET\Framework\ versionNumber folder and specify the -A m option (for example aspnet_regsql.exe -A m). 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 membership 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 defines a default SqlMembershipProvider instance named AspNetSqlMembershipProvider that connects to the default SQL Server Express instance on the local machine. You can use this instance of the provider if you installed SQL Server Express with the default instance name, or you can define your own instance in the Web.config file for your ASP.NET application.

If you set the passwordCompatMode attribute to Framework40, the application can use the hashing and encryption membership options that were added in ASP.NET 4. However, if the passwordCompatMode attribute is set to Framework20, only the hashing and encryption membership options from the ASP.NET 2.0, ASP.NET 3.5, and ASP.NET 3.5 SP1 can be used. The default value is Framework20. For more information, see MembershipPasswordCompatibilityMode.

The following code example shows the Web.config file for an ASP.NET application configured to use a SqlMembershipProvider.

    <add name="SqlServices" connectionString="Data Source=localhost;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
    <authentication mode="Forms" >
      <forms loginUrl="login.aspx"
        name=".ASPXFORMSAUTH" />
      <deny users="?" />
    <membership defaultProvider="SqlProvider"
          passwordAttemptWindow="10" />

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top