Provides data for the WindowsAuthentication_OnAuthenticate event. This class cannot be inherited.
System.EventArgs
System.Web.Security.WindowsAuthenticationEventArgs
Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)
Public NotInheritable Class WindowsAuthenticationEventArgs _ Inherits EventArgs
public sealed class WindowsAuthenticationEventArgs : EventArgs
public ref class WindowsAuthenticationEventArgs sealed : public EventArgs
[<Sealed>] type WindowsAuthenticationEventArgs = class inherit EventArgs end
The WindowsAuthenticationEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
|
WindowsAuthenticationEventArgs | Initializes a newly created instance of the WindowsAuthenticationEventArgs class. |
| Name | Description | |
|---|---|---|
|
Context | Gets the HttpContext object for the current HTTP request. |
|
|
Identity | Gets the Windows identity passed to the WindowsAuthenticationEventArgs constructor. |
|
|
User | Gets or sets the IPrincipal object to be associated with the current request. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
The WindowsAuthenticationEventArgs class is used to supply event values to the WindowsAuthentication_OnAuthenticate event and to enable you to specify a custom Windows identity for the current request.
The WindowsAuthenticationModule constructs a WindowsAuthenticationEventArgs object using the Windows identity supplied by IIS and the current HttpContext and passes it to the WindowsAuthentication_OnAuthenticate event.
You can use the User property of the WindowsAuthenticationEventArgs object supplied to the WindowsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object. If you do not specify a value for the User property during the WindowsAuthentication_OnAuthenticate event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the Identity property is set to the identity returned by the GetAnonymous method.
The WindowsAuthentication_OnAuthenticate event is raised only when the authentication Mode is set to Windows and the WindowsAuthenticationModule is an active HTTP module for the application.
The following code example uses the WindowsAuthentication_OnAuthenticate event to set the User property of the current HttpContext to a custom IPrincipal object.
Public Sub WindowsAuthentication_OnAuthenticate(sender As Object, args As WindowsAuthenticationEventArgs) If Not args.Identity.IsAnonymous Then args.User = New Samples.AspNet.Security.MyPrincipal(args.Identity) End If End Sub
public void WindowsAuthentication_OnAuthenticate(object sender, WindowsAuthenticationEventArgs args) { if (!args.Identity.IsAnonymous) { args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity); } }
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.