Sdílet prostřednictvím

WSFederationAuthenticationModule.CreateSignInRequest Metoda

Definice

Obor názvů:
System.IdentityModel.Services
Sestavení:
System.IdentityModel.Services.dll

Vytvoří zprávu WS-Federation žádosti o přihlášení pomocí parametrů WS-Federation nakonfigurovaných v modulu.

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 uloží tuto hodnotu do parametru wctx v žádosti o přihlášení WS-Federation; modul ho ale nepoužívá při zpracování žádostí o přihlášení nebo odpovědí na přihlášení. Můžete ji nastavit na libovolnou hodnotu. Nemusí být jedinečný.

returnUrl
String

Adresa URL, na kterou by se modul měl vrátit při ověřování.

rememberMeSet
Boolean

WSFAM uloží tuto hodnotu do parametru wctx v žádosti o přihlášení WS-Federation; modul ho ale nepoužívá při zpracování žádostí o přihlášení nebo odpovědí na přihlášení. Můžete ho nastavit buď true nebo false.

Návraty

SignInRequestMessage

Zpráva WS-Federation žádosti o přihlášení.

Výjimky

InvalidOperationException

Vlastnost Issuer je null nebo prázdný řetězec.

nebo

Vlastnost Realm je null nebo prázdný řetězec.

Poznámky

Vytvoří WS-Federation žádost o přihlášení, která je reprezentována objektem SignInRequestMessage . Vlastnosti nového SignInRequestMessage objektu jsou nastaveny takto:

  • Vlastnost Context (parametr wctx) je nastavena na hodnotu vytvořenou pomocí parametrů metody.

  • Vlastnost CurrentTime (parametr wct) je nastavena na aktuální čas.

  • Všechny ostatní vlastnosti jsou nastaveny pomocí ekvivalentních vlastností aktuální instance.

Parametry předané metodě slouží k vytvoření parametru zprávy wctx. Jedná se o řetězec s následujícím formátem: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Hodnota ru je nastavena na hodnotu returnUrl parametru předaného metodě a určuje adresu URL, kterou by modul měl směrovat prohlížeč na následující úspěšné ověření. Toto je jediná hodnota uložená v řetězci wctx, který používá WSFAM. Modul volá metodu GetReturnUrlFromResponse , která extrahuje tuto hodnotu z parametru wctx při zpracování odpovědi WS-Federation přihlášení. Nemělo by být zaměňováno s parametrem zprávy wreply, který je určen Reply vlastností a který poskytuje adresu v RP, na kterou má služba tokenu zabezpečení (STS) směrovat svou odpověď.

  • Parametr cx je nastaven na hodnotu SignInContext vlastnosti. Tato vlastnost je zpřístupněna, abyste mohli nastavit libovolný kontext definovaný aplikací, který by měl být uložen v řetězci wctx; WSFAM však nezpřístupňuje metodu pro extrakci této hodnoty v odpovědi. Pokud je hodnota potřebná vaší aplikací, je nutné zadat kód pro parsování řetězce wctx a čtení této hodnoty při zpracování odpovědi. Můžete toho dosáhnout přepsáním GetReturnUrlFromResponse metody.

  • rm Hodnota, která je nastavena na hodnotu parametrurememberMeSet, ani id parametr, který je nastaven na hodnotu parametruuniqueId, se používá WSFAM. Tyto hodnoty lze nastavit na libovolnou hodnotu.

Metoda CreateSignInRequest je volána z RedirectToIdentityProvider metody.

Platí pro

Viz také