Export (0) Print
Expand All

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)

public ref class FormsAuthenticationModule sealed : IHttpModule
public final class FormsAuthenticationModule implements IHttpModule
public final class FormsAuthenticationModule implements IHttpModule
Not applicable.

The FormsAuthenticationModule sets the current System.Web.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.

NoteNote:

In IIS 7.0, using the WindowsAuthenticationModule with the FormsAuthenticationModule is not supported. For more information about compatibility issues in Integrated modes, see Upgrading ASP.NET Applications to IIS 7.0: Differences between IIS 7.0 Integrated Mode and Classic mode.

The following example uses the FormsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object.

No code example is currently available or this language may not be supported.

System.Object
  System.Web.Security.FormsAuthenticationModule

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft