WSFederationAuthenticationModule.FederatedSignOut(Uri, Uri) 方法
定义
使用 WS-Federation 协议,在指定的安全标记的服务 (STS) 中注销。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)
参数
- signOutUrl
- Uri
接收 WS-Federation 注销请求消息的 STS 的 URL。The URL of the STS to receive the WS-Federation sign-out request message. 不能为 null。Cannot be null.
- replyUrl
- Uri
将作为 wreply 值发送的注销请求消息 URL。The URL to be sent as the wreply value in the sign-out request message.
例外
signOutUrl 不是 null 并且不是绝对 URI。signOutUrl is not null and is not an absolute URI.
- 或 --or-
replyUrl 不是 null 并且不是绝对 URI。replyUrl is not null and is not an absolute URI.
signOutUrl 为 null。signOutUrl is null.
注解
调用此方法可将 WS-Federation 注销请求消息发送到指定的 STS。Call this method to send a WS-Federation sign-out request message to the specified STS. 您可以选择为注销请求中的 wreply 参数提供一个值。You can optionally supply a value for the wreply parameter in the sign-out request.
该方法将执行以下操作:The method does the following:
使用指定的参数创建 WS-Federation 注销请求消息。Creates a WS-Federation sign-out request message by using the specified parameters.
对 SessionAuthenticationModule.DeleteSessionTokenCookie SAM 调用方法以删除会话 cookie。Calls the SessionAuthenticationModule.DeleteSessionTokenCookie method on the SAM to delete the session cookie.
使用第一步中的注销请求消息重定向到 STS。Redirects to the STS using the sign-out request message from the first step.
SigningOut SignedOut SignOutError 此方法不会引发任何注销事件:、或。None of the sign-out events: SigningOut, SignedOut, or SignOutError are raised by this method. 若要删除会话而不向 STS 发送注销请求消息,请调用重载的 SignOut 方法之一。To delete the session without sending a sign-out request message to the STS, call one of the overloaded SignOut methods.
备注
若要使用会话令牌执行被动注销,该模块依赖于登录期间在属性中存储的值 SessionSecurityToken.Context 。有关详细信息,请参阅 GetSessionTokenContext 方法。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.