Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
FederationConfiguration Class

FederationConfiguration Class

.NET Framework 4.6 and 4.5

Exposes properties that contain federation settings that control the behavior of the WS-Federation Authentication Module (WSFederationAuthenticationModule) and the Session Authentication Module (SessionAuthenticationModule) in web applications.


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

public class FederationConfiguration

The FederationConfiguration type exposes the following members.

Public methodFederationConfiguration()Initializes a new instance of the FederationConfiguration class by loading settings from the system.identityModel.services section of the configuration file.
Public methodFederationConfiguration(Boolean)Initializes a new instance of the FederationConfiguration class by optionally loading settings from the system.identityModel.services section of the configuration file.
Public methodFederationConfiguration(String)Initializes a new instance of the FederationConfiguration class from the <federationConfiguration> element with the specified name.

Public propertyCookieHandlerGets or sets the cookie handler to be used by the Session Authentication Module (SessionAuthenticationModule).
Public propertyCustomElementGets or sets the custom XML element, if any, present in this configuration.
Public propertyIdentityConfigurationGets or sets the IdentityConfiguration object associated with this instance.
Public propertyIsInitializedGets or sets a value that indicates whether the Initialize method has been called.
Public propertyNameGets the name associated with this instance.
Public propertyServiceCertificateGets or sets the X.509 certificate used to sign WS-Federation protocol messages.
Public propertyWsFederationConfigurationGets or sets the configuration settings for the WS-Federation Authentication Module (WSFederationAuthenticationModule).

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeInitializes the current instance.
Protected methodLoadConfigurationLoads the properties for the current instance from the configuration file. This method is called by constructors that initialize the newly created FederationConfiguration from configuration settings.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public fieldStatic memberDefaultFederationConfigurationNameDefines the name of the default <federationConfiguration> element from which settings should be loaded. This is an empty string as the default element is unnamed.

By default web applications have a single FederationConfiguration object that is accessed through the FederatedAuthentication.FederationConfiguration property. The first time the property is accessed a new FederationConfiguration instance is initialized from settings in the configuration file and the FederatedAuthentication.FederationConfigurationCreated event is raised. You can use the properties and methods exposed by the FederationConfiguration class to modify or replace the object initialized from configuration in an event handler. This object is available through the FederationConfigurationCreatedEventArgs.FederationConfiguration property inside the event handler.

.NET Framework

Supported in: 4.6, 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.
© 2015 Microsoft