This documentation is archived and is not being maintained.

IAuthenticationModule Interface

Provides the base authentication interface for Web client authentication modules.

Namespace:  System.Net
Assembly:  System (in System.dll)

type IAuthenticationModule =  interface end

The IAuthenticationModule type exposes the following members.

  NameDescription
Public propertyAuthenticationTypeGets the authentication type provided by this authentication module.
Public propertyCanPreAuthenticateGets a value indicating whether the authentication module supports preauthentication.
Top

  NameDescription
Public methodAuthenticateReturns an instance of the Authorization class in respose to an authentication challenge from a server.
Public methodPreAuthenticateReturns an instance of the Authorization class for an authentication request to a server.
Top

The IAuthenticationModule interface defines the properties and methods that custom authentication modules must use.

Authentication modules conduct the entire authentication process with a server, responding to an authentication challenge as appropriate. This process may consist of requests to an authentication server separate from the resource server, as well as any other activities required to properly authenticate a request for a URI.

Custom authentication modules should implement the IAuthenticationModule interface and then register with the AuthenticationManager.Register method. Authentication modules are also registered at program initialization by reading the configuration file.

The following example creates creates a customized authentication class by implementing the IAuthenticationModule interface. For a complete example refer to the AuthenticationManager class.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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