DefaultAuthenticationModule Class


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

Ensures that an authentication object is present in the context. This class cannot be inherited.

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


type DefaultAuthenticationModule = 
        interface IHttpModule


Initializes a new instance of the DefaultAuthenticationModule class.


Releases all resources, other than memory, used by the DefaultAuthenticationModule.


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


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


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


Initializes the DefaultAuthenticationModule object.


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


Occurs after the request has been authenticated.

The DefaultAuthenticationModule ensures that the User property of the current HttpContext instance is set to an IPrincipal object for each request. The DefaultAuthenticationModule examines the User property after the AuthenticateRequest event and before the AuthorizeRequest event. If the User property is null, the DefaultAuthenticationModule sets the User property to a GenericPrincipal object that contains no user information.

If the authentication module sets the StatusCode property to 401, the DefaultAuthenticationModule will render an access-denied error page. If the value of the StatusCode property is set to a value greater than 200, the DefaultAuthenticationModule object will end the request. In that case, only HTTP modules that subscribe to the EndRequest event are called prior to the completion of the current request.

The DefaultAuthenticationModule exposes an Authenticate event. You can use this event to provide a custom IPrincipal object for the User property of the current HttpContext instance. The Authenticate event is accessed by specifying an event named DefaultAuthentication_OnAuthenticate in the application's Global.asax file.

The following example uses the DefaultAuthentication_OnAuthenticate event to test whether the User property of the current HttpContext instance is null. If the User property is null, then the sample sets the User property of the current HttpContext instance to a GenericPrincipal object where the Identity of the GenericPrincipal object is a GenericIdentity with a Name value of "default."


The DefaultAuthentication_OnAuthenticate event is raised before the AuthorizeRequest event. As a result, if you set the User property of the current HttpContext instance to a custom identity, it can affect the behavior of your application. For example, if you are using the FormsAuthentication class and you specify <deny users="?" /> in the configuration section to ensure that only authenticated users have access to your site, this sample will cause the element to be ignored, as the user will have a name, which is "default." Instead, you would specify <deny users="default" /> to ensure that only authenticated users can access your site.

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

.NET Framework
Available since 1.1

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