Udostępnij za pośrednictwem

WSFederationAuthenticationModule.SignOut Metoda

  • Odwołanie

Definicja

Przestrzeń nazw:
System.IdentityModel.Services
Zestaw:
System.IdentityModel.Services.dll

Wy loguje się z bieżącej sesji.

Przeciążenia

SignOut()

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do adresu URL określonego w bieżącym żądaniu HTTP.
SignOut(Boolean)

Wy loguje się z bieżącej sesji i zgłasza odpowiednie zdarzenia.
SignOut(String)

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do określonego adresu URL.
SignOut(String, Boolean)

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do określonego adresu URL.

Uwagi

Usuwa bieżącą sesję.

Do usługi tokenu zabezpieczającego (STS) nie jest wysyłany komunikat o żądaniu wylogowania ("wsignout1.0"). Aby wylogować się w usłudze STS przy użyciu protokołu WS-Federation, użyj FederatedSignOut metody .

SignOut()

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do adresu URL określonego w bieżącym żądaniu HTTP.

public:
 virtual void SignOut();
public virtual void SignOut ();
abstract member SignOut : unit -> unit
override this.SignOut : unit -> unit
Public Overridable Sub SignOut ()

Uwagi

Usuwa bieżącą sesję i przekierowuje przeglądarkę z powrotem do adresu URL określonego w bieżącym żądaniu HTTP.

Wywołuje metodę WSFederationAuthenticationModule.SignOut(String) z parametrem ustawionym redirectUrl na adres URL bieżącego żądania.

Do usługi tokenu zabezpieczającego (STS) nie jest wysyłany komunikat o żądaniu wylogowania ("wsignout1.0"). Aby wylogować się w usłudze STS przy użyciu protokołu WS-Federation, użyj FederatedSignOut metody .

Dotyczy

SignOut(Boolean)

Wy loguje się z bieżącej sesji i zgłasza odpowiednie zdarzenia.

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)

Parametry

isIPRequest
Boolean

true jeśli żądanie zostało zainicjowane przez usługę IP-STS za pośrednictwem WS-Federation komunikatu o żądaniu czyszczenia wylogowywanie ("wsignoutcleanup1.0"); w przeciwnym razie , false.

Uwagi

Ta metoda wykonuje rzeczywistą pracę usuwania bieżącej sesji i zgłaszania odpowiednich zdarzeń wylogowania. Metoda wykonuje następujące czynności:

  1. Wywołuje metodę OnSigningOutSigningOut , aby zgłosić zdarzenie. Procedura obsługi zdarzeń może zapewnić wszelkie niezbędne przetwarzanie przed usunięciem sesji. Właściwość SigningOutEventArgs.IsIPInitiated jest ustawiana zgodnie z parametrem isIPRequest .

  2. Wywołuje metodę SessionAuthenticationModule.DeleteSessionTokenCookie w bieżącym menedżerze uwierzytelniania sesji, aby usunąć plik cookie sesji.

    Wywołuje metodę OnSignedOutSignedOut , aby zgłosić zdarzenie.

  3. Jeśli podczas przetwarzania wylogowania wystąpi błąd, wywoła OnSignOutError metodę SignOutError , aby zgłosić zdarzenie. Procedura obsługi zdarzeń może anulować przetwarzanie i uniemożliwić powrót wyjątku do obiektu wywołującego SignOut

Możesz wywołać metodę WSFederationAuthenticationModule.SignOut z ustawionym false parametremisIPRequest, aby wylogować się z sesji bez wykonywania przekierowania. Metoda jest ostatecznie wywoływana przez wszystkie inne przeciążone SignOut metody (z parametrem ustawionym isIPRequest na false), aby wykonać obsługę wylogowywanie. Metoda jest wywoływana z metody z parametrem ustawionym trueisIPRequest w celu wylogowania się z WSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase, Boolean) sesji podczas przetwarzania komunikatu czyszczenia WS-Federation wylogowania ("wsignoutcleanup1.0").

Do usługi tokenu zabezpieczającego (STS) nie jest wysyłany komunikat o żądaniu wylogowania ("wsignout1.0"). Aby wylogować się w usłudze STS przy użyciu protokołu WS-Federation, użyj FederatedSignOut metody .

Dotyczy

SignOut(String)

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do określonego adresu 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)

Parametry

redirectUrl
String

Adres URL, do którego należy przekierować przeglądarkę po usunięciu sesji.

Wyjątki

ArgumentException

redirectUrl nie jest prawidłowym identyfikatorem URI.

Uwagi

Usuwa bieżącą sesję i przekierowuje przeglądarkę z powrotem do określonego adresu URL.

Wywołuje metodę WSFederationAuthenticationModule.SignOut(String, Boolean) z parametrem redirectUrl i zestawem initiateSignoutCleanupfalse.

Do usługi tokenu zabezpieczającego (STS) nie jest wysyłany komunikat o żądaniu wylogowania ("wsignout1.0"). Aby wylogować się w usłudze STS przy użyciu protokołu WS-Federation, użyj FederatedSignOut metody .

Dotyczy

SignOut(String, Boolean)

Wyloguje się z bieżącej sesji i żąda przekierowania z powrotem do określonego adresu 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)

Parametry

redirectUrl
String

Adres URL, do którego należy przekierować przeglądarkę po wylogowaniu.

initiateSignoutCleanup
Boolean

Zawsze ustawiaj wartość false. Ustawienie tego parametru na true wartość nie jest obsługiwane.

Wyjątki

ArgumentException

redirectUrl nie jest prawidłowym identyfikatorem URI.

NotImplementedException

Klasa WSFederationAuthenticationModule zgłasza ten wyjątek, jeśli initiateSignoutCleanup jest to true. Nie ustawiaj tego parametru na true.

Uwagi

Usuwa bieżącą sesję i przekierowuje przeglądarkę z powrotem do określonego adresu URL.

Wywołuje metodę WSFederationAuthenticationModule.SignOut(Boolean) z zestawem falseparametrów initiateSignoutCleanup .

Do usługi tokenu zabezpieczającego (STS) nie jest wysyłany komunikat o żądaniu wylogowania ("wsignout1.0"). Aby wylogować się w usłudze STS przy użyciu protokołu WS-Federation, użyj FederatedSignOut metody .

Dotyczy