WSFederationAuthenticationModule.CreateSignInRequest Metódus

Definíció

Létrehoz egy WS-Federation bejelentkezési kérelemüzenetet a modulon konfigurált WS-Federation paraméterek használatával.

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

Paraméterek

uniqueId
String

A WSFAM a wctx paraméterben menti ezt az értéket a WS-Federation bejelentkezési kérelemben; a modul azonban nem használja a bejelentkezési kérések vagy bejelentkezési válaszok feldolgozásakor. Bármilyen értékre beállíthatja. Nem kell egyedinek lennie.

returnUrl
String

Az URL-cím, amelyre a modulnak a hitelesítéskor vissza kell térnie.

rememberMeSet
Boolean

A WSFAM a wctx paraméterben menti ezt az értéket a WS-Federation bejelentkezési kérelemben; a modul azonban nem használja a bejelentkezési kérések vagy bejelentkezési válaszok feldolgozásakor. Beállíthatja vagy be is állíthatja.truefalse

Válaszok

A WS-Federation bejelentkezési kérés üzenete.

Kivételek

A Issuer tulajdonság vagy null egy üres sztring.

-vagy-

A Realm tulajdonság vagy null egy üres sztring.

Megjegyzések

Létrehoz egy WS-Federation bejelentkezési kérést, amelyet egy SignInRequestMessage objektum jelöl. Az új SignInRequestMessage objektum tulajdonságai a következőképpen vannak beállítva:

  • A Context tulajdonság (a wctx paraméter) a metódusparaméterek használatával létrehozott értékre van állítva.

  • A CurrentTime tulajdonság (a wct paraméter) az aktuális időpontra van állítva.

  • Az összes többi tulajdonság az aktuális példány megfelelő tulajdonságaival van beállítva.

A rendszer a metódusnak átadott paramétereket használja a wctx üzenetparaméter létrehozásához. Ez egy sztring a következő formátumban: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Az ru érték a metódusnak átadott paraméter értékére returnUrl van állítva, és megadja azt az URL-címet, amelyet a modulnak a sikeres hitelesítés követésére kell irányítania a böngészőnek. Ez az egyetlen, a WSFAM által használt wctx-sztringben tárolt érték. A modul meghívja a metódust, GetReturnUrlFromResponse hogy kinyerje ezt az értéket a wctx paraméterből egy WS-Federation bejelentkezési válasz feldolgozásakor. Nem tévesztendő össze a tulajdonság által Reply megadott wreply üzenetparaméterrel, amely azon az RP-címen adja meg a címet, amelyre a biztonsági jogkivonat-szolgáltatásnak (STS) a válaszát irányítania kell.

  • A cx paraméter a tulajdonság értékére SignInContext van állítva. Ez a tulajdonság lehetővé teszi az alkalmazás által definiált környezetek beállítását, amelyeket a wctx-sztringben kell tárolni; A WSFAM azonban nem tesz közzé egy metódust, amely kinyeri ezt az értéket a válaszban. Ha az alkalmazásnak szüksége van az értékre, meg kell adnia a wctx sztring elemzéséhez szükséges kódot, és be kell olvasnia ezt az értéket a válasz feldolgozásakor. Ezt a metódus felülírásával GetReturnUrlFromResponse teheti meg.

  • A WSFAM sem a rm paraméter értékére rememberMeSet beállított értéket, sem a id paraméter értékét uniqueId nem használja. Ezek bármilyen értékre beállíthatók.

A CreateSignInRequest metódus meghívása a RedirectToIdentityProvider metódusból történik.

A következőre érvényes:

Lásd még