WindowsAuthenticationEventArgs.Identity Property

 
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.

Gets the Windows identity passed to the WindowsAuthenticationEventArgs constructor.

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

public WindowsIdentity Identity { get; }

Property Value

Type: System.Security.Principal.WindowsIdentity

The Windows identity passed to the WindowsAuthenticationEventArgs constructor.

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.

If IIS uses anonymous authentication, the Identity property is set to the identity returned by the GetAnonymous method.

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

public void WindowsAuthentication_OnAuthenticate(object sender, WindowsAuthenticationEventArgs args)
{
  if (!args.Identity.IsAnonymous)
  {
    args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity);
  }
}

.NET Framework
Available since 1.1
Return to top
Show: