FormsAuthenticationModule Class
Sets the identity of the user for an ASP.NET application when forms authentication is enabled. This class cannot be inherited.
Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)
The FormsAuthenticationModule type exposes the following members.
| Name | Description | |
|---|---|---|
 | FormsAuthenticationModule | Initializes a new instance of the FormsAuthenticationModule class. |
| Name | Description | |
|---|---|---|
| Dispose | Releases all resources, other than memory, used by the FormsAuthenticationModule. |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Init | Initializes the FormsAuthenticationModule object. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
The FormsAuthenticationModule sets the current HttpContext::User property to an IPrincipal object that represents the user identity for the current request when the authentication Mode is set to Forms in the authentication Element (ASP.NET Settings Schema) element of the application's configuration file.
The FormsAuthenticationModule exposes an Authenticate event that enables you to provide a custom IPrincipal object for the User property of the current HttpContext. The Authenticate event is accessed by specifying a subroutine named FormsAuthentication_OnAuthenticate in the Global.asax file for your ASP.NET application.
| Note |
|---|
In IIS 7.0, using the WindowsAuthenticationModule with the FormsAuthenticationModule is not supported. For more information about compatibility issues in Integrated modes, see Moving an ASP.NET Application from IIS 6.0 to IIS 7.0. |
The following example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object.
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.
