Freigeben über

WSFederationAuthenticationModule.CreateSignInRequest Methode

Definition

Namespace:
System.IdentityModel.Services
Assembly:
System.IdentityModel.Services.dll

Erstellt eine WS-Federation Anmeldeanforderungsnachricht mithilfe der im Modul konfigurierten WS-Federation Parameter.

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

Parameter

uniqueId
String

WSFAM speichert diesen Wert im wctx-Parameter in der WS-Federation Anmeldeanforderung; Das Modul verwendet es jedoch nicht beim Verarbeiten von Anmeldeanforderungen oder Anmeldeantworten. Sie können ihn auf einen beliebigen Wert festlegen. Er muss nicht eindeutig sein.

returnUrl
String

Die URL, an die das Modul bei der Authentifizierung zurückgegeben werden soll.

rememberMeSet
Boolean

WSFAM speichert diesen Wert im wctx-Parameter in der WS-Federation Anmeldeanforderung; Das Modul verwendet es jedoch nicht beim Verarbeiten von Anmeldeanforderungen oder Anmeldeantworten. Sie können es entweder true oder false.

Gibt zurück

SignInRequestMessage

Die WS-Federation Anmeldeanforderungsnachricht.

Ausnahmen

InvalidOperationException

Die Issuer Eigenschaft ist null oder eine leere Zeichenfolge.

- oder -

Die Realm Eigenschaft ist null oder eine leere Zeichenfolge.

Hinweise

Erstellt eine WS-Federation Anmeldeanforderung, die durch ein SignInRequestMessage Objekt dargestellt wird. Die Eigenschaften des neuen SignInRequestMessage Objekts werden wie folgt festgelegt:

  • Die Context Eigenschaft (der wctx-Parameter) wird auf einen Wert festgelegt, der mithilfe der Methodenparameter erstellt wird.

  • Die CurrentTime Eigenschaft (der wct-Parameter) wird auf die aktuelle Uhrzeit festgelegt.

  • Alle anderen Eigenschaften werden mithilfe der entsprechenden Eigenschaften der aktuellen Instanz festgelegt.

Die an die Methode übergebenen Parameter werden verwendet, um den wctx-Nachrichtenparameter zu erstellen. Dies ist eine Zeichenfolge mit dem folgenden Format: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • Der ru Wert wird auf den Wert des Parameters festgelegt, der returnUrl an die Methode übergeben wird, und gibt die URL an, die das Modul den Browser an die erfolgreiche Authentifizierung weiterleiten soll. Dies ist der einzige Wert, der in der wctx-Zeichenfolge gespeichert ist, die von WSFAM verwendet wird. Das Modul ruft die GetReturnUrlFromResponse Methode auf, um diesen Wert aus dem wctx-Parameter zu extrahieren, wenn eine WS-Federation Anmeldeantwort verarbeitet wird. Es sollte nicht mit dem wreply-Nachrichtenparameter verwechselt werden, der von der Reply Eigenschaft angegeben wird und die Adresse an der RP bereitstellt, an die der Sicherheitstokendienst (Security Token Service, STS) seine Antwort leiten soll.

  • Der cx Parameter wird auf den Wert der SignInContext Eigenschaft festgelegt. Diese Eigenschaft wird verfügbar gemacht, damit Sie alle anwendungsdefinierten Kontexte festlegen können, die in der wctx-Zeichenfolge gespeichert werden sollen. WSFAM macht jedoch keine Methode verfügbar, um diesen Wert in der Antwort zu extrahieren. Wenn der Wert von Ihrer Anwendung benötigt wird, müssen Sie den Code angeben, um die wctx-Zeichenfolge zu analysieren und diesen Wert beim Verarbeiten der Antwort zu lesen. Sie können dies erreichen, indem Sie die GetReturnUrlFromResponse Methode außer Kraft setzen.

  • Weder der Wert, der rm auf den Wert des rememberMeSet Parameters festgelegt ist, noch der id Parameter, der auf den Wert des uniqueId Parameters festgelegt ist, werden von WSFAM verwendet. Diese können auf einen beliebigen Wert festgelegt werden.

Die CreateSignInRequest Methode wird von der RedirectToIdentityProvider Methode aufgerufen.

Gilt für:

Weitere Informationen