Freigeben über

WSFederationAuthenticationModule.CreateSignInRequest Methode

  • Referenz

Definition

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

Erstellt einen WS-Verbund in Anforderungnachricht mithilfe der WS-Verbund-Parameter, die im Modul konfiguriert werden.

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-Verbund-Anmeldungsanforderung. Allerdings verwendet das Modul den Wert nicht, wenn es Anmeldungsanforderungen oder Anmeldungsantworten verarbeitet. Sie können jeden beliebigen Wert festlegen. Er muss nicht eindeutig sein.

returnUrl
String

Die URL, zu der das Modul nach der Authentifizierung zurückkehren soll.

rememberMeSet
Boolean

WSFAM speichert diesen Wert im wctx-Parameter in der WS-Verbund-Anmeldungsanforderung. Allerdings verwendet das Modul den Wert nicht, wenn es Anmeldungsanforderungen oder Anmeldungsantworten verarbeitet. Sie können den Wert auf true oder false festlegen.

Gibt zurück

SignInRequestMessage

Die WS-Verbund-Anmeldungsanforderungsnachricht.

Ausnahmen

InvalidOperationException

Die Issuer-Eigenschaft ist null oder enthält eine leere Zeichenfolge ("").

- oder -

Die Realm-Eigenschaft ist null oder enthält 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 instance festgelegt.

Die an die -Methode übergebenen Parameter werden verwendet, um den wctx-Meldungsparameter zu erstellen. Dies ist eine Zeichenfolge im 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 wurde, und gibt die URL an, die das Modul nach erfolgreicher Authentifizierung an den Browser 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. Er sollte nicht mit dem wreply message-Parameter verwechselt werden, der von der Reply -Eigenschaft angegeben wird und der die Adresse am Rp angibt, an die der Sicherheitstokendienst (SECURITY Token Service, STS) seine Antwort weiterleiten soll.

  • Der cx Parameter wird auf den Wert der SignInContext -Eigenschaft festgelegt. Diese Eigenschaft wird verfügbar gemacht, damit Sie jeden anwendungsdefinierten Kontext festlegen können, der in der wctx-Zeichenfolge gespeichert werden soll. 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 bei der Verarbeitung der Antwort zu lesen. Sie können dies erreichen, indem Sie die GetReturnUrlFromResponse -Methode überschreiben.

  • Weder der rm Wert, der auf den Wert des rememberMeSet Parameters festgelegt ist, noch der Parameter, der id 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