Udostępnij za pośrednictwem

WSFederationAuthenticationModule.CreateSignInRequest Metoda

  • Odwołanie

Definicja

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

Tworzy komunikat żądania logowania WS-Federation przy użyciu parametrów WS-Federation skonfigurowanych w module.

public:
 System::IdentityModel::Services::SignInRequestMessage ^ CreateSignInRequest(System::String ^ uniqueId, System::String ^ returnUrl, bool rememberMeSet);
public System.IdentityModel.Services.SignInRequestMessage CreateSignInRequest (string uniqueId, string returnUrl, bool rememberMeSet);
member this.CreateSignInRequest : string * string * bool -> System.IdentityModel.Services.SignInRequestMessage
Public Function CreateSignInRequest (uniqueId As String, returnUrl As String, rememberMeSet As Boolean) As SignInRequestMessage

Parametry

uniqueId
String

WSFAM zapisuje tę wartość w parametrze wctx w żądaniu logowania WS-Federation; Jednak moduł nie używa go podczas przetwarzania żądań logowania lub odpowiedzi logowania. Można ustawić ją na dowolną wartość. Nie musi być wyjątkowy.

returnUrl
String

Adres URL, do którego moduł powinien zostać zwrócony po uwierzytelnieniu.

rememberMeSet
Boolean

WSFAM zapisuje tę wartość w parametrze wctx w żądaniu logowania WS-Federation; Jednak moduł nie używa go podczas przetwarzania żądań logowania lub odpowiedzi logowania. Można go ustawić albo truefalse.

Zwraca

SignInRequestMessage

Komunikat żądania logowania WS-Federation.

Wyjątki

InvalidOperationException

Właściwość Issuer jest null lub jest pustym ciągiem.

-lub-

Właściwość Realm jest null lub jest pustym ciągiem.

Uwagi

Tworzy żądanie logowania WS-Federation reprezentowane SignInRequestMessage przez obiekt. Właściwości nowego SignInRequestMessage obiektu są ustawiane w następujący sposób:

  • Właściwość Context (parametr wctx) jest ustawiona na wartość utworzoną przy użyciu parametrów metody.

  • Właściwość CurrentTime (parametr wct) jest ustawiona na bieżący czas.

  • Wszystkie inne właściwości są ustawiane przy użyciu równoważnych właściwości bieżącego wystąpienia.

Parametry przekazywane do metody są używane do tworzenia parametru komunikatu wctx. Jest to ciąg o następującym formacie: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Wartość ru jest ustawiona na wartość parametru przekazanego returnUrl do metody i określa adres URL, który moduł powinien skierować przeglądarkę do po pomyślnym uwierzytelnieniu. Jest to jedyna wartość przechowywana w ciągu wctx, który jest używany przez usługę WSFAM. Moduł wywołuje metodę GetReturnUrlFromResponse w celu wyodrębnienia tej wartości z parametru wctx podczas przetwarzania odpowiedzi logowania WS-Federation. Nie należy go mylić z wreply parametr komunikatu, który jest określony przez Reply właściwość i który dostarcza adres w rp, do którego usługa tokenu zabezpieczającego (STS) powinna kierować jego odpowiedź.

  • Parametr cx jest ustawiany na wartość SignInContext właściwości . Ta właściwość jest uwidoczniona, aby umożliwić ustawianie dowolnego kontekstu zdefiniowanego przez aplikację, który powinien być przechowywany w ciągu wctx; jednak usługa WSFAM nie ujawnia metody wyodrębniania tej wartości w odpowiedzi. Jeśli wartość jest potrzebna przez aplikację, należy podać kod, aby przeanalizować ciąg wctx i odczytać tę wartość podczas przetwarzania odpowiedzi. Można to zrobić, przesłaniając metodę GetReturnUrlFromResponse .

  • rm Ani wartość, która jest ustawiona na wartość parametrurememberMeSet, ani id parametru, który jest ustawiony na wartość parametruuniqueId, są używane przez usługę WSFAM. Można je ustawić na dowolną wartość.

Metoda CreateSignInRequest jest wywoływana RedirectToIdentityProvider z metody .

Dotyczy

Zobacz też