WebSsoAuthenticationModule Class

Article
10/10/2016

Acts as the resource Web Server HttpModule. Enables ASP.NET applications to use AD FS for authentication.

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

Inheritance Hierarchy

System.Object
System.Web.Security.SingleSignOn.WebSsoAuthenticationModule

Syntax

public class WebSsoAuthenticationModule : IHttpModule

public ref class WebSsoAuthenticationModule : IHttpModule

type WebSsoAuthenticationModule = 
    class
        interface IHttpModule
    end

Public Class WebSsoAuthenticationModule
    Implements IHttpModule

Constructors

	Name	Description
	WebSsoAuthenticationModule()	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebSsoAuthenticationModule class. Do not use this constructor. Use the Init method instead.

Methods

	Name	Description
	Dispose()	Frees, releases, or resets unmanaged resources.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	Init(HttpApplication)	Initializes an HttpApplication on the Logon Server.
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	Authenticate	Authenticates the WebSsoAuthenticationEventHandler.

Remarks

The Web Server uses the ASP.NET WebSsoAuthenticationModule to obtain the identity of the user and perform the access check. To add this module to a Web application, the web.config file for the resource Web Server virtual directory must include an entry for this HttpModule.

The WebSsoAuthenticationModule registers a handler for the BeginRequest event and processes the WebSSO protocol messages at this point by performing all the necessary cookie, query string and HTTP POST message processing. Depending on the configuration, the WebSsoAuthenticationModule may perform 302 redirects to the Logon Server automatically or it may pass control to the resource Web form if the client is not authenticated.

Thread Safety

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