FederationConfiguration Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

System.Object
  System.IdentityModel.Services.Configuration.FederationConfiguration

public class FederationConfiguration

NameDescription
System_CAPS_pubmethodFederationConfiguration()

Initializes a new instance of the FederationConfiguration class by loading settings from the system.identityModel.services section of the configuration file.

System_CAPS_pubmethodFederationConfiguration(Boolean)

Initializes a new instance of the FederationConfiguration class by optionally loading settings from the system.identityModel.services section of the configuration file.

System_CAPS_pubmethodFederationConfiguration(String)

Initializes a new instance of the FederationConfiguration class from the <federationConfiguration> element with the specified name.

NameDescription
System_CAPS_pubpropertyCookieHandler

Gets or sets the cookie handler to be used by the Session Authentication Module (SessionAuthenticationModule).

System_CAPS_pubpropertyCustomElement

Gets or sets the custom XML element, if any, present in this configuration.

System_CAPS_pubpropertyIdentityConfiguration

Gets or sets the IdentityConfiguration object associated with this instance.

System_CAPS_pubpropertyIsInitialized

Gets or sets a value that indicates whether the Initialize method has been called.

System_CAPS_pubpropertyName

Gets the name associated with this instance.

System_CAPS_pubpropertyServiceCertificate

Gets or sets the X.509 certificate used to sign WS-Federation protocol messages.

System_CAPS_pubpropertyWsFederationConfiguration

Gets or sets the configuration settings for the WS-Federation Authentication Module (WSFederationAuthenticationModule).

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the current instance.

System_CAPS_protmethodLoadConfiguration(FederationConfigurationElement)

Loads 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.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefaultFederationConfigurationName

Defines 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
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: