WSFederationAuthenticationModule.SignOut 方法

定义

命名空间:

System.IdentityModel.Services

程序集:

System.IdentityModel.Services.dll

注册当前对话。

重载

SignOut()	当前会话的注销并要求重定向回在当前 HTTP 指定的 URL。
SignOut(Boolean)	当前会话的注销并引发相应事件。
SignOut(String)	当前会话的注销并要求重定向回指定的 URL。
SignOut(String, Boolean)	当前会话的注销并要求重定向回指定的 URL。

注解

删除当前会话。

不会向 STS) 的安全令牌服务发送 (“wsignout1.0”) (注销请求消息。 若要使用 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。

不会向 STS) 的安全令牌服务发送 (“wsignout1.0”) (注销请求消息。 若要使用 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

可以使用参数集false调用 WSFederationAuthenticationModule.SignOut 方法isIPRequest，以注销会话，而无需执行重定向。 该方法最终由所有其他重载 SignOut 方法调用， (isIPRequest 参数设置为 false) 以执行注销处理。 在处理 WS-Federation 注销清除消息 (“wsignoutcleanup1.0”) 时，从 方法调用 WSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase, Boolean) 方法，并将 isIPRequest 参数设置为 true 注销会话。

不会向 STS) 的安全令牌服务发送 (“wsignout1.0”) (注销请求消息。 若要使用 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)使用 redirectUrl 参数和initiateSignoutCleanup集 false调用 方法。

不会向 STS) 的安全令牌服务发送 (“wsignout1.0”) (注销请求消息。 若要使用 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。

不会向 STS) 的安全令牌服务发送 (“wsignout1.0”) (注销请求消息。 若要使用 WS-Federation 协议在 STS 注销，请使用 FederatedSignOut 方法。