Partager via


WSFederationAuthenticationModule.CreateSignInRequest Méthode

Définition

Crée un message de demande de connexion WS-Federation à l’aide des paramètres de WS-Federation configurés sur le module.

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ètres

uniqueId
String

WSFAM enregistre cette valeur dans le paramètre wctx dans la demande de connexion WS-Federation ; Toutefois, le module ne l’utilise pas lors du traitement des demandes de connexion ou des réponses de connexion. Vous pouvez le définir sur n’importe quelle valeur. Il n'est pas nécessaire qu'elle soit unique.

returnUrl
String

URL à laquelle le module doit retourner lors de l’authentification.

rememberMeSet
Boolean

WSFAM enregistre cette valeur dans le paramètre wctx dans la demande de connexion WS-Federation ; Toutefois, le module ne l’utilise pas lors du traitement des demandes de connexion ou des réponses de connexion. Vous pouvez le définir soit true .false

Retours

Message de demande de connexion WS-Federation.

Exceptions

La Issuer propriété est null ou une chaîne vide.

- ou -

La Realm propriété est null ou une chaîne vide.

Remarques

Crée une demande de connexion WS-Federation représentée par un SignInRequestMessage objet. Les propriétés du nouvel SignInRequestMessage objet sont définies comme suit :

  • La Context propriété (paramètre wctx) est définie sur une valeur créée à l’aide des paramètres de méthode.

  • La CurrentTime propriété (paramètre wct) est définie sur l’heure actuelle.

  • Toutes les autres propriétés sont définies à l’aide des propriétés équivalentes de l’instance actuelle.

Les paramètres passés à la méthode sont utilisés pour créer le paramètre de message wctx. Il s’agit d’une chaîne au format suivant : ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId.

  • La ru valeur est définie sur la valeur du returnUrl paramètre passé à la méthode et spécifie l’URL que le module doit diriger le navigateur vers la réussite de l’authentification. Il s’agit de la seule valeur stockée dans la chaîne wctx utilisée par WSFAM. Le module appelle la GetReturnUrlFromResponse méthode pour extraire cette valeur du paramètre wctx lors du traitement d’une réponse de connexion WS-Federation. Il ne doit pas être confondu avec le paramètre de message wreply, qui est spécifié par la Reply propriété et qui fournit l’adresse au niveau du fournisseur de ressources auquel le service de jeton de sécurité (STS) doit diriger sa réponse.

  • Le cx paramètre est défini sur la valeur de la SignInContext propriété. Cette propriété est exposée pour vous permettre de définir tout contexte défini par l’application qui doit être stocké dans la chaîne wctx ; Toutefois, WSFAM n’expose pas de méthode pour extraire cette valeur dans la réponse. Si la valeur est nécessaire par votre application, vous devez fournir le code pour analyser la chaîne wctx et lire cette valeur lors du traitement de la réponse. Pour ce faire, vous pouvez remplacer la GetReturnUrlFromResponse méthode.

  • Ni la rm valeur, qui est définie sur la valeur du rememberMeSet paramètre, ni le id paramètre, qui est défini sur la valeur du uniqueId paramètre sont utilisés par WSFAM. Celles-ci peuvent être définies sur n’importe quelle valeur.

La CreateSignInRequest méthode est appelée à partir de la RedirectToIdentityProvider méthode.

S’applique à

Voir aussi