FederatedAuthentication.FederationConfiguration Property

.NET Framework (current version)
 

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

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

public static FederationConfiguration FederationConfiguration { get; }

Property Value

Type: System.IdentityModel.Services.Configuration.FederationConfiguration

The federation configuration instance.

A FederationConfiguration object is created and initialized from the <federationConfiguration> element in the configuration file the first time this property is accessed by one of the HTTP modules. Just after the configuration object has been initialized, the FederationConfigurationCreated event is raised to provide a developer with an opportunity to modify the newly created configuration object before it is used to initialize any of the configured HTTP modules. It can be accessed from the FederationConfigurationCreatedEventArgs.FederationConfiguration property in an event handler.

On subsequent accesses, the same configuration instance is returned.

Depending on whether specific modules are present, the property is accessed from within the following methods during initialization: ClaimsAuthorizationModule.InitializePropertiesFromConfiguration, SessionAuthenticationModule.InitializePropertiesFromConfiguration, and WSFederationAuthenticationModule.InitializePropertiesFromConfiguration.

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
Return to top
Show: