WSFederationAuthenticationModule.FederatedSignOut(Uri, Uri) Method

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.

Signs out at the specified security token service (STS) by using the WS-Federation protocol.

public:
 static void FederatedSignOut(Uri ^ signOutUrl, Uri ^ replyUrl);

public static void FederatedSignOut (Uri signOutUrl, Uri replyUrl);

static member FederatedSignOut : Uri * Uri -> unit

Public Shared Sub FederatedSignOut (signOutUrl As Uri, replyUrl As Uri)

Parameters

signOutUrl: Uri

The URL of the STS to receive the WS-Federation sign-out request message. Cannot be null.

replyUrl: Uri

The URL to be sent as the wreply value in the sign-out request message.

Exceptions

ArgumentException

signOutUrl is not null and is not an absolute URI.

-or-

replyUrl is not null and is not an absolute URI.

InvalidOperationException

signOutUrl is null.

Remarks

Call this method to send a WS-Federation sign-out request message to the specified STS. You can optionally supply a value for the wreply parameter in the sign-out request.

The method does the following:

Creates a WS-Federation sign-out request message by using the specified parameters.
Calls the SessionAuthenticationModule.DeleteSessionTokenCookie method on the SAM to delete the session cookie.
Redirects to the STS using the sign-out request message from the first step.

None of the sign-out events: SigningOut, SignedOut, or SignOutError are raised by this method. To delete the session without sending a sign-out request message to the STS, call one of the overloaded SignOut methods.

Note

To perform passive sign-out by using the session token, the module relies on a value that was stored in the SessionSecurityToken.Context property during sign-in, for more information, see the GetSessionTokenContext method.

Applies to

Jaa