FederationConfiguration Class

Definition

Namespace:

System.IdentityModel.Services.Configuration

Assembly:

System.IdentityModel.Services.dll

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.

public ref class FederationConfiguration

public class FederationConfiguration

type FederationConfiguration = class

Public Class FederationConfiguration

Inheritance

Object

FederationConfiguration

Remarks

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.

Constructors

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

Fields

DefaultFederationConfigurationName

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.

Properties

CookieHandler	Gets or sets the cookie handler to be used by the Session Authentication Module (SessionAuthenticationModule).
CustomElement	Gets or sets the custom XML element, if any, present in this configuration.
IdentityConfiguration	Gets or sets the IdentityConfiguration object associated with this instance.
IsInitialized	Gets or sets a value that indicates whether the Initialize() method has been called.
Name	Gets the name associated with this instance.
ServiceCertificate	Gets or sets the X.509 certificate used to sign WS-Federation protocol messages.
WsFederationConfiguration	Gets or sets the configuration settings for the WS-Federation Authentication Module (WSFederationAuthenticationModule).

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
Initialize()	Initializes the current instance.
LoadConfiguration(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.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)