WSFederationAuthenticationModule.SignOut 方法

定義

命名空間:

System.IdentityModel.Services

組件:

System.IdentityModel.Services.dll

登出目前工作階段。

多載

SignOut()	豋出目前工作階段並要求重新導向至目前 HTTP 要求中指定的 URL。
SignOut(Boolean)	登出目前工作階段並引發適當的事件。
SignOut(String)	登出目前工作階段並要求重新導向至指定的 URL。
SignOut(String, Boolean)	登出目前工作階段並要求重新導向至指定的 URL。

備註

刪除目前的工作階段。

(“wsignout1.0”) 沒有註銷要求訊息傳送至 STS (安全性令牌服務) 。 若要使用 WS-Federation 通訊協定在 STS 註銷，請使用 FederatedSignOut 方法。

SignOut()

豋出目前工作階段並要求重新導向至目前 HTTP 要求中指定的 URL。

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 方法。

SignOut(Boolean)

登出目前工作階段並引發適當的事件。

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)

參數

isIPRequest

Boolean

如果要求是由 IP-STS 透過 WS-同盟登出清除要求訊息 ("wsignoutcleanup1.0") 所啟始，則為 true，否則為 false。

備註

此方法會執行刪除目前會話的實際工作，並引發適當的註銷事件。 方法會執行下列動作：

1. OnSigningOut叫用 方法來引發 SigningOut 事件。 事件處理程式可以在刪除會話之前提供任何必要的處理。 屬性 SigningOutEventArgs.IsIPInitiated 會根據 isIPRequest 參數來設定。

2. SessionAuthenticationModule.DeleteSessionTokenCookie呼叫目前會話驗證管理員上的 方法，以刪除會話 Cookie。

   OnSignedOut叫用 方法來引發 SignedOut 事件。

3. 如果在註銷處理期間發生錯誤，請 OnSignOutError 叫用 方法來引發 SignOutError 事件。 事件處理程式可以取消處理，並防止例外狀況傳回給的呼叫端 SignOut

您可以呼叫 WSFederationAuthenticationModule.SignOut 方法， isIPRequest 並將 參數設定 false 為註銷會話，而不需執行重新導向。 方法最終會由所有其他多載 SignOut 方法呼叫， (isIPRequest 參數設定為 false) 來執行註銷處理。 從 WSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase, Boolean) 方法呼叫 方法 isIPRequest ，其參數設定 true 為在處理 WS-Federation 註銷清除訊息 (“wsignoutcleanup1.0”) 時註銷會話。

(“wsignout1.0”) 沒有註銷要求訊息傳送至 STS (安全性令牌服務) 。 若要使用 WS-Federation 通訊協定在 STS 註銷，請使用 FederatedSignOut 方法。

SignOut(String)

登出目前工作階段並要求重新導向至指定的 URL。

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)

參數

redirectUrl

String

工作階段刪除後瀏覽器應該重新導向的 URL。

例外狀況

ArgumentException

redirectUrl 不是有效的 URI。

備註

刪除目前的工作階段，並將瀏覽器重新導向回指定的URL。

WSFederationAuthenticationModule.SignOut(String, Boolean)使用 參數和集合 false叫用 redirectUrlinitiateSignoutCleanup 方法。

(“wsignout1.0”) 沒有註銷要求訊息傳送至 STS (安全性令牌服務) 。 若要使用 WS-Federation 通訊協定在 STS 註銷，請使用 FederatedSignOut 方法。

SignOut(String, Boolean)

登出目前工作階段並要求重新導向至指定的 URL。

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)

參數

redirectUrl

String

登出後瀏覽器應該重新導向的 URL。

initiateSignoutCleanup

Boolean

一律設為 false。 不支援將這個參數設為 true。

例外狀況

ArgumentException

redirectUrl 不是有效的 URI。

NotImplementedException

如果initiateSignoutCleanup 是 true，WSFederationAuthenticationModule 類別會擲回此例外狀況。 不要將這個參數設定為 true。

備註

刪除目前的工作階段，並將瀏覽器重新導向回指定的URL。

WSFederationAuthenticationModule.SignOut(Boolean)使用參數集 false叫用 initiateSignoutCleanup 方法。

(“wsignout1.0”) 沒有註銷要求訊息傳送至 STS (安全性令牌服務) 。 若要使用 WS-Federation 通訊協定在 STS 註銷，請使用 FederatedSignOut 方法。