WSFederationAuthenticationModule.SignOut Method (String, Boolean)

.NET Framework 4.6 and 4.5

Signs out of the current session and requests a redirect back to the specified URL.

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

public virtual void SignOut(
	string redirectUrl,
	bool initiateSignoutCleanup
)

Parameters

redirectUrl
Type: System.String

The URL to which the browser should be redirected after sign-out.

initiateSignoutCleanup
Type: System.Boolean

Always set false. Setting this parameter to true is not supported.

ExceptionCondition
ArgumentException

redirectUrl is not a valid URI.

NotImplementedException

The WSFederationAuthenticationModule class throws this exception if initiateSignoutCleanup is true. Do not set this parameter to true.

Deletes the current session and redirects the browser back to the specified URL.

Invokes the WSFederationAuthenticationModule.SignOut(Boolean) method with the initiateSignoutCleanup parameter set false.

No sign-out request message (“wsignout1.0”) is sent to the security token service (STS). To sign-out at the STS using WS-Federation protocol, use the FederatedSignOut method.

.NET Framework

Supported in: 4.6, 4.5
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft