FederatedAuthentication.FederationConfiguration Property

Definition

Namespace:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

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

public:
 static property System::IdentityModel::Services::Configuration::FederationConfiguration ^ FederationConfiguration { System::IdentityModel::Services::Configuration::FederationConfiguration ^ get(); };

public static System.IdentityModel.Services.Configuration.FederationConfiguration FederationConfiguration { get; }

static member FederationConfiguration : System.IdentityModel.Services.Configuration.FederationConfiguration

Public Shared ReadOnly Property FederationConfiguration As FederationConfiguration

Property Value

FederationConfiguration

The federation configuration instance.

Exceptions

InvalidOperationException

The FederationConfiguration property is set to null by an event handler for the FederationConfigurationCreated event.

Remarks

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.

Important

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.

See also

• <federationConfiguration>