WSFederationAuthenticationModule.CreateSignInRequest Metod

Definition

Namnområde:
System.IdentityModel.Services
Sammansättning:
System.IdentityModel.Services.dll

Skapar ett meddelande om WS-Federation inloggningsbegäran med hjälp av de WS-Federation parametrar som konfigurerats i modulen.

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

Parametrar

uniqueId
String

WSFAM sparar det här värdet i wctx-parametern i WS-Federation inloggningsbegäran. Modulen använder den dock inte när du bearbetar inloggningsbegäranden eller inloggningssvar. Du kan ange det till valfritt värde. Det behöver inte vara unikt.

returnUrl
String

Den URL som modulen ska returneras till vid autentisering.

rememberMeSet
Boolean

WSFAM sparar det här värdet i wctx-parametern i WS-Federation inloggningsbegäran. Modulen använder den dock inte när du bearbetar inloggningsbegäranden eller inloggningssvar. Du kan ange antingen true eller false.

Returer

SignInRequestMessage

Meddelandet WS-Federation inloggningsbegäran.

Undantag

InvalidOperationException

Egenskapen Issuer är null eller en tom sträng.

-eller-

Egenskapen Realm är null eller en tom sträng.

Kommentarer

Skapar en WS-Federation inloggningsbegäran som representeras av ett SignInRequestMessage objekt. Egenskaperna för det nya SignInRequestMessage objektet anges på följande sätt:

  • Egenskapen Context (wctx-parametern) anges till ett värde som skapas med hjälp av metodparametrarna.

  • Egenskapen CurrentTime (wct-parametern) är inställd på den aktuella tiden.

  • Alla andra egenskaper anges med hjälp av motsvarande egenskaper för den aktuella instansen.

Parametrarna som skickas till metoden används för att skapa wctx-meddelandeparametern. Det här är en sträng med följande format: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Värdet ru anges till värdet för parametern returnUrl som skickas till metoden och anger den URL som modulen ska dirigera webbläsaren till efter lyckad autentisering. Det här är det enda värdet som lagras i wctx-strängen som används av WSFAM. Modulen GetReturnUrlFromResponse anropar metoden för att extrahera det här värdet från wctx-parametern när du bearbetar ett WS-Federation inloggningssvar. Det bör inte förväxlas med parametern wreply message, som anges av Reply egenskapen och som tillhandahåller adressen på den RP som säkerhetstokentjänsten (STS) ska dirigera sitt svar till.

  • Parametern cx är inställd på värdet för SignInContext egenskapen. Den här egenskapen exponeras så att du kan ange alla programdefinierade kontexter som ska lagras i wctx-strängen. WSFAM exponerar dock inte någon metod för att extrahera det här värdet i svaret. Om värdet behövs av ditt program måste du ange koden för att parsa wctx-strängen och läsa det här värdet när du bearbetar svaret. Du kan göra detta genom att GetReturnUrlFromResponse åsidosätta metoden.

  • Varken värdet rm , som är inställt på värdet för parametern rememberMeSet eller parametern id , som är inställt på värdet för parametern uniqueId , används av WSFAM. Dessa kan anges till valfritt värde.

Metoden CreateSignInRequest anropas från RedirectToIdentityProvider -metoden.

Gäller för

Se även