Export (0) Print
Expand All

WsFederationConfiguration Class

.NET Framework 4.5

Contains all of the configuration settings needed by the WS-Federation Authentication Module (WSFederationAuthenticationModule).

System.Object
  System.IdentityModel.Services.Configuration.WsFederationConfiguration

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

public class WsFederationConfiguration

The WsFederationConfiguration type exposes the following members.

  NameDescription
Public methodWsFederationConfiguration(WSFederationElement)Initializes a new instance of the WsFederationConfiguration class from the specified <wsFederation> element.
Public methodWsFederationConfiguration(String, String)Initializes a new instance of the WsFederationConfiguration class by using the specified issuer and realm.
Top

  NameDescription
Public propertyAuthenticationTypeGets or sets the value of the wauth parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyCustomAttributesGets a dictionary that contains any extra attributes specified in the <wsFederation> element in the configuration file.
Public propertyFreshnessGets or sets the value of the wfresh parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyHomeRealmGets or sets the value of the whr parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyIssuerGets or sets a URI that identifies the intended issuer of the security token.
Public propertyPassiveRedirectEnabledGets or sets a value that specifies whether the module is enabled to initiate WS-Federation protocol redirects.
Public propertyPersistentCookiesOnPassiveRedirectsGets or sets a value that specifies whether a persistent session cookie is issued on successful authentication.
Public propertyPolicyGets or sets the value of the wp parameter to be used in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyRealmGets or sets the value of the wtrealm parameter to be used for WS-Federation sign-in requests (“wsignin1.0”).
Public propertyReplyGets or sets the value of the wreply parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyRequestGets or sets the value of the wreq parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyRequestPtrGets or sets the value of the wreqptr parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertyRequireHttpsGets or sets a value that specifies whether communication with the security token service (STS) must use HTTPS protocol.
Public propertyResourceGet or sets the value of the wres parameter to use in WS-Federation sign-in requests (“wsignin1.0”).
Public propertySignInQueryStringGets or sets a query string that contains any additional parameters to be sent in WS-Federation sign-in requests (“wsignin1.0”).
Public propertySignOutQueryStringGets or sets a query string that contains any additional parameters to be sent in WS-Federation sign-out requests (“wsignout1.0”) during passive sign-out.
Public propertySignOutReplyGets or sets the value of the wreply parameter to use during WS-Federation sign-out requests (“wsignout1.0”).
Public propertyXmlDictionaryReaderQuotasGets or sets the configurable quota values for XML dictionary readers used by this instance.
Top

  NameDescription
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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberDefaultFreshnessA constant that contains the default value for the Freshness property; zero.
Public fieldStatic memberDefaultMaxArrayLengthA constant that sets the default MaxArrayLength property of the XML dictionary reader quotas object referenced by the XmlDictionaryReaderQuotas property.
Public fieldStatic memberDefaultMaxStringContentLengthA constant that sets the default MaxStringContentLength property of the XML dictionary reader quotas object referenced by the XmlDictionaryReaderQuotas property.
Public fieldStatic memberDefaultPassiveRedirectEnabledA constant that contains the default value for the PassiveRedirectEnabled property; true, passive redirects are enabled.
Public fieldStatic memberDefaultPersistentCookiesOnPassiveRedirectsA constant that contains the default value for the PersistentCookiesOnPassiveRedirects property; false, cookies are not enabled.
Public fieldStatic memberDefaultRequireHttpsA constant that contains the default value for the RequireHttps property; true, HTTPS is required on redirects.
Top

An instance of the WsFederationConfiguration class that is set on the FederationConfiguration object accessed through the FederatedAuthentication.FederationConfiguration property contains the settings that are used to initialize the properties of the WS-Federation Authentication Module (WSFAM) and control its behavior. These settings are typically loaded from the <wsFederation> element in the configuration file.

.NET Framework

Supported in: 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft