Export (0) Print
Expand All

FederatedAuthentication Class

.NET Framework 4.5

Provides access to state pertinent to all HTTP modules relevant to federated authentication in the web application.

System.Object
  System.IdentityModel.Services.FederatedAuthentication

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

'Declaration
Public NotInheritable Class FederatedAuthentication

The FederatedAuthentication type exposes the following members.

  NameDescription
Public propertyStatic memberClaimsAuthorizationModuleGets the claims authorization module used by the web application.
Public propertyStatic memberFederationConfigurationGets the singleton FederationConfiguration instance used by the HTTP modules in this web application.
Public propertyStatic memberSessionAuthenticationModuleGets the session authentication module (SAM) used by the web application.
Public propertyStatic memberWSFederationAuthenticationModuleGets the WS-Federation Authentication Module (WSFAM) used by the web application.
Top

  NameDescription
Public methodStatic memberGetHttpModule(Of T)Gets the HTTP module of the specified type that is being used by the web application.
Top

  NameDescription
Public eventStatic memberFederationConfigurationCreatedOccurs when the FederationConfiguration property is accessed for the first time by one of the HTTP modules in the web application.
Top

You can access the modules that are configured for the web application through the static properties exposed by the FederatedAuthentication class. The GetHttpModule(Of T) method provides an extension point through which other application-defined modules that derive from HttpModuleBase and that are configured for the application can be accessed.

The FederatedAuthentication.FederationConfiguration property references a singleton instance of FederationConfiguration that provides configuration settings for the HTTP modules. The first time the property is accessed by one of the HTTP modules, a FederationConfiguration instance is initialized from the <federationConfiguration> element in the configuration file and the FederationConfigurationCreated is raised to provide an application with the opportunity to modify the configuration object before it is used to initialize module properties. The same FederationConfiguration instance is returned on each subsequent access of the property.

Important noteImportant

The claims authorization manager (ClaimsAuthorizationManager) that is used to evaluate claims based access checks when using the ClaimsPrincipalPermission class or the ClaimsPrincipalPermissionAttribute class is configured on the IdentityConfiguration object that is set on the federation configuration object referenced through the FederatedAuthentication.FederationConfiguration property. This is true for all applications whether they are ASP.NET applications or not.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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