FederatedAuthentication Class

.NET Framework (current version)
 

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

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

System.Object
  System.IdentityModel.Services.FederatedAuthentication

public static class FederatedAuthentication

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticClaimsAuthorizationModule

Gets the claims authorization module used by the web application.

System_CAPS_pubpropertySystem_CAPS_staticFederationConfiguration

Gets the singleton FederationConfiguration instance used by the HTTP modules in this web application.

System_CAPS_pubpropertySystem_CAPS_staticSessionAuthenticationModule

Gets the session authentication module (SAM) used by the web application.

System_CAPS_pubpropertySystem_CAPS_staticWSFederationAuthenticationModule

Gets the WS-Federation Authentication Module (WSFAM) used by the web application.

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticGetHttpModule<T>()

Gets the HTTP module of the specified type that is being used by the web application.

NameDescription
System_CAPS_pubeventSystem_CAPS_staticFederationConfigurationCreated

Occurs when the FederationConfiguration property is accessed for the first time by one of the HTTP modules in the web application.

You can access the modules that are configured for the web application through the static properties exposed by the FederatedAuthentication class. The GetHttpModule<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.

System_CAPS_importantImportant

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
Available since 4.5

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: