WSFederationAuthenticationModule.SignOut メソッド

public:
 virtual void SignOut();

public virtual void SignOut ();

abstract member SignOut : unit -> unit
override this.SignOut : unit -> unit

Public Overridable Sub SignOut ()

注釈

現在のセッションを削除し、ブラウザーを現在の HTTP 要求で指定された URL にリダイレクトします。

パラメーターを現在の WSFederationAuthenticationModule.SignOut(String) 要求の redirectUrl URL に設定して、 メソッドを呼び出します。

サインアウト要求メッセージ ("wsignout1.0") はセキュリティ トークン サービス (STS) に送信されません。 WS-Federation プロトコルを使用して STS でサインアウトするには、 メソッドを使用します FederatedSignOut 。

public:
 virtual void SignOut(bool isIPRequest);

public virtual void SignOut (bool isIPRequest);

abstract member SignOut : bool -> unit
override this.SignOut : bool -> unit

Public Overridable Sub SignOut (isIPRequest As Boolean)

パラメーター

注釈

このメソッドは、現在のセッションを削除し、適切なサインアウト イベントを発生させる実際の作業を実行します。 メソッドは次の処理を行います。

1. メソッドを OnSigningOut 呼び出して イベントを SigningOut 発生させます。 イベント ハンドラーは、セッションが削除される前に必要な処理を提供できます。 プロパティは SigningOutEventArgs.IsIPInitiated 、 パラメーターに従って isIPRequest 設定されます。

2. 現在の SessionAuthenticationModule.DeleteSessionTokenCookie セッション認証マネージャーで メソッドを呼び出して、セッション Cookie を削除します。

   メソッドを OnSignedOut 呼び出して イベントを SignedOut 発生させます。

3. サインアウト処理中にエラーが発生した場合は、 メソッドを OnSignOutError 呼び出して イベントを SignOutError 発生させます。 イベント ハンドラーは、処理を取り消し、 の呼び出し元に例外が返されないようにすることができます。 SignOut

パラメーターを設定falseして メソッドをWSFederationAuthenticationModule.SignOutisIPRequest呼び出して、リダイレクトを実行せずにセッションからサインアウトできます。 メソッドは、最終的には、サインアウト処理を実行するために、他のすべてのオーバーロードされた SignOut メソッド (パラメーターを isIPRequest に false設定) によって呼び出されます。 メソッドは、 パラメーターをisIPRequest設定trueして メソッドからWSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase, Boolean)呼び出され、WS-Federation サインアウト クリーンアップ メッセージ ("wsignoutcleanup1.0") を処理しているときにセッションからサインアウトします。

サインアウト要求メッセージ ("wsignout1.0") はセキュリティ トークン サービス (STS) に送信されません。 WS-Federation プロトコルを使用して STS でサインアウトするには、 メソッドを使用します FederatedSignOut 。

public:
 virtual void SignOut(System::String ^ redirectUrl);

public virtual void SignOut (string redirectUrl);

abstract member SignOut : string -> unit
override this.SignOut : string -> unit

Public Overridable Sub SignOut (redirectUrl As String)

パラメーター

例外

注釈

現在のセッションを削除し、ブラウザーを指定した URL にリダイレクトします。

パラメーターと セット falseをWSFederationAuthenticationModule.SignOut(String, Boolean)使用して redirectUrl メソッドをinitiateSignoutCleanup呼び出します。

サインアウト要求メッセージ ("wsignout1.0") はセキュリティ トークン サービス (STS) に送信されません。 WS-Federation プロトコルを使用して STS でサインアウトするには、 メソッドを使用します FederatedSignOut 。

public:
 virtual void SignOut(System::String ^ redirectUrl, bool initiateSignoutCleanup);

public virtual void SignOut (string redirectUrl, bool initiateSignoutCleanup);

abstract member SignOut : string * bool -> unit
override this.SignOut : string * bool -> unit

Public Overridable Sub SignOut (redirectUrl As String, initiateSignoutCleanup As Boolean)

パラメーター

例外

注釈

現在のセッションを削除し、ブラウザーを指定した URL にリダイレクトします。

パラメーターが に設定falseされた WSFederationAuthenticationModule.SignOut(Boolean) 状態で メソッドをinitiateSignoutCleanup呼び出します。

サインアウト要求メッセージ ("wsignout1.0") はセキュリティ トークン サービス (STS) に送信されません。 WS-Federation プロトコルを使用して STS でサインアウトするには、 メソッドを使用します FederatedSignOut 。