WSFederationAuthenticationModule.SignOutQueryString Property

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a query string that contains any additional parameters to be sent in WS-Federation sign-out requests ("wsignout1.0").

public:
 property System::String ^ SignOutQueryString { System::String ^ get(); void set(System::String ^ value); };

public string SignOutQueryString { get; set; }

member this.SignOutQueryString : string with get, set

Public Property SignOutQueryString As String

Property Value

String

A URL fragment that contains the additional message parameters in the following format: param1=value1&param2=value2&paramN=valueN. The default is an empty string.

Exceptions

ArgumentNullException

An attempt to set the property to null occurs.

Remarks

By default, this property is initialized from the signOutQueryString attribute of the <wsFederation> element in the configuration file. It is intended to contain any application-specific parameters to be sent in a WS-Federation sign-out request. To remove these parameters, you can set the property to an empty string.

The WSFAM does not use this property directly; however, you can pass it to the GetFederationPassiveSignOutUrl method to create a complete WS-Federation sign-out URL that can then be used by your code.

Applies to