WindowsAuthenticationEventArgs Class

 
System_CAPS_noteNote

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

Provides data for the WindowsAuthentication_OnAuthenticate event. This class cannot be inherited.

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

System.Object
  System.EventArgs
    System.Web.Security.WindowsAuthenticationEventArgs

Public NotInheritable Class WindowsAuthenticationEventArgs
	Inherits EventArgs

NameDescription
System_CAPS_pubmethodWindowsAuthenticationEventArgs(WindowsIdentity, HttpContext)

Initializes a newly created instance of the WindowsAuthenticationEventArgs class.

NameDescription
System_CAPS_pubpropertyContext

Gets the HttpContext object for the current HTTP request.

System_CAPS_pubpropertyIdentity

Gets the Windows identity passed to the WindowsAuthenticationEventArgs constructor.

System_CAPS_pubpropertyUser

Gets or sets the IPrincipal object to be associated with the current request.

NameDescription
System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

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

System_CAPS_pubmethodToString()

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

.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
Show: