PassportIdentity.LoginUser Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification du client sensible à Passport. Cette classe est déconseillée.
Surcharges
LoginUser() |
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée. |
LoginUser(String) |
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée. |
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object) |
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification du client sensible à Passport. Cette classe est déconseillée. |
LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object) |
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée. |
Remarques
Cette classe a été déconseillée et n’est plus prise en charge. Microsoft Passport Network a été remplacé par Windows Live ID.
LoginUser()
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée.
public:
int LoginUser();
public int LoginUser ();
member this.LoginUser : unit -> int
Public Function LoginUser () As Integer
Retours
Code de résultat sous forme d'entier.
Remarques
Cette classe a été déconseillée et n’est plus prise en charge. Microsoft Passport Network a été remplacé par Windows Live ID.
S’applique à
LoginUser(String)
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée.
public:
int LoginUser(System::String ^ strReturnUrl);
public int LoginUser (string strReturnUrl);
member this.LoginUser : string -> int
Public Function LoginUser (strReturnUrl As String) As Integer
Paramètres
- strReturnUrl
- String
URL vers laquelle le serveur de connexion doit rediriger les utilisateurs à la fin de l'inscription. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
Retours
Code de résultat sous forme d'entier.
Remarques
Cette classe a été déconseillée et n’est plus prise en charge. Microsoft Passport Network a été remplacé par Windows Live ID.
S’applique à
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification du client sensible à Passport. Cette classe est déconseillée.
public:
int LoginUser(System::String ^ szRetURL, int iTimeWindow, bool fForceLogin, System::String ^ szCOBrandArgs, int iLangID, System::String ^ strNameSpace, int iKPP, bool fUseSecureAuth, System::Object ^ oExtraParams);
public int LoginUser (string szRetURL, int iTimeWindow, bool fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, bool fUseSecureAuth, object oExtraParams);
member this.LoginUser : string * int * bool * string * int * string * int * bool * obj -> int
Public Function LoginUser (szRetURL As String, iTimeWindow As Integer, fForceLogin As Boolean, szCOBrandArgs As String, iLangID As Integer, strNameSpace As String, iKPP As Integer, fUseSecureAuth As Boolean, oExtraParams As Object) As Integer
Paramètres
- szRetURL
- String
URL vers laquelle le serveur de connexion doit rediriger les utilisateurs à la fin de l'inscription. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iTimeWindow
- Int32
Valeur de temps exprimée en secondes. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- fForceLogin
- Boolean
true
pour que le serveur de connexion compare le paramètre iTimeWindow
à la durée écoulée depuis la dernière inscription de l'utilisateur ; false
pour que le serveur de connexion iTimeWindow
à l'heure à laquelle a eu lieu la dernière actualisation du ticket. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- szCOBrandArgs
- String
Chaîne spécifiant les variables à ajouter sous forme de chaîne de requête à l'URL de la page de script Cobranding Template du participant. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iLangID
- Int32
Identificateur de paramètres régionaux (LCID) spécifiant la langue dans laquelle afficher la page de connexion. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- strNameSpace
- String
Espace de noms de domaine vers lequel diriger les utilisateurs ne possédant pas de passeports pour s'inscrire. L'espace de noms spécifié doit apparaître en tant qu'entrée « nom de domaine » dans Partner.xml, document relatif à la configuration des composants. L'espace de noms par défaut est généralement « passport.com ». Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iKPP
- Int32
Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut. Ce paramètre n'est utile que lors de l'implémentation du service Kids Passport ; cependant, ce service ne prend pas encore en charge l'utilisation de cette méthode.
- fUseSecureAuth
- Boolean
La connexion SSL n'est pas une option disponible sur les serveurs de connexion dans leur version actuelle. Les méthodes du Gestionnaire d'identités Passport incluent des paramètres de connexion SSL ; elles peuvent être requises pour des questions de syntaxe mais sont pour le moment ignorées par le serveur. Recherche des mises à jour de l'état de la connexion SSL sur le site web Passport. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- oExtraParams
- Object
Paires nom-valeur à insérer directement dans l'en-tête d'authentification de Challenge, en particulier pour les interactions relatives aux authentifications sensibles à Passport. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
Retours
Code de résultat sous forme d'entier.
Exemples
<!--
This example demonstrates implementing the soft sign-in authentication approach.
In order for the example to work, the following requirements must be met.
You can find details on these requirements in the Passport SDK documentation.
1. You must modify the Web.config file associated with this page so that
authentication mode is set to "Passport".
2. You must have the Passport SDK installed.
3. You must have a Passport Site ID for the site where your page resides.
If your Site ID is in the PREP environment, you will also need a PREP Passport.
4. You must have installed the encryption key you received after registering
your site and receiving a site ID.
5. You must have the Passport Manager object settings correctly configured for
your site.
-->
<!--
This example demonstrates implementing the soft sign-in authentication approach.
In order for the example to work, the following requirements must be met.
You can find details on these requirements in the Passport SDK documentation.
1. You must modify the Web.config file associated with this page so that
authentication mode is set to "Passport".
2. You must have the Passport SDK installed.
3. You must have a Passport Site ID for the site where your page resides.
If your Site ID is in the PREP environment, you will also need a PREP Passport.
4. You must have installed the encryption key you received after registering your
site and receiving a site ID.
5. You must have the Passport Manager object settings correctly configured for your site.
-->
<%@ Page language="c#" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Runtime.InteropServices" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
private void Page_Load(object sender, System.EventArgs e)
{
try
{
// Determine whether Passport is the type of authentication
// this page is set to use. (Authentication information
// is set in the Web.config file.)
if (!(this.Context.User.Identity is PassportIdentity))
{
// If this page isn't set to use Passport authentication,
// quit now.
this.Response.Write("Error: Passport authentication failed. " +
"Make sure that the Passport SDK is installed " +
"and your Web.config file is configured correctly.");
return;
}
// Expire the page to avoid the browser's cache.
Response.Cache.SetNoStore();
// Get a version of the Identity value that is cast as type
// PassportIdentity.
//<Snippet4>
//<Snippet5>
//<Snippet6>
PassportIdentity identity = (this.Context.User.Identity as PassportIdentity);
// Determine whether the user is already signed in with a valid
// and current ticket. Passing -1 for the parameter values
// indicates the default values will be used.
if (identity.GetIsAuthenticated(-1, -1, -1))
{
this.Response.Write("Welcome to the site.<br /><br />");
// Print the Passport sign in button on the screen.
this.Response.Write(identity.LogoTag2());
//</Snippet6>
// Make sure the user has core profile information before
// trying to access it.
if (identity.HasProfile("core"))
{
this.Response.Write("<b>You have been authenticated as " +
"Passport identity:" + identity.Name + "</b></p>");
}
}
//</Snippet5>
// Determine whether the user has a ticket.
else if (identity.HasTicket)
{
// If the user has a ticket but wasn't authenticated, that
// means the ticket is stale, so the login needs to be refreshed.
// Passing true as the fForceLogin parameter value indicates that
// silent refresh will be accepted.
identity.LoginUser(null, -1, true, null, -1, null, -1, true, null);
}
//</Snippet4>
// If the user does not already have a ticket, ask the user
// to sign in.
else
{
this.Response.Write("Please sign in using the link below.<br /><br />");
// Print the Passport sign in button on the screen.
this.Response.Write(identity.LogoTag2());
}
}
catch (System.Runtime.InteropServices.COMException comError)
{
this.Response.Write("An error occurred while working with the " +
"Passport SDK.");
}
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
</form>
</body>
</html>
<%@ Page language="VB" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Runtime.InteropServices" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Private Sub Page_Load(sender As Object, e As System.EventArgs)
Try
' Determine whether Passport is the type of authentication
' this page is set to use. (Authentication information
' is set in the Web.config file.)
If Not TypeOf(Me.Context.User.Identity) Is PassportIdentity Then
' If this page isn't set to use Passport authentication,
' quit now.
Me.Response.Write("Error: Passport authentication failed. " & _
"Make sure that the Passport SDK is installed and your " & _
"Web.config file is configured correctly.")
Return
End If
' Expire the page to avoid the browser's cache.
Response.Cache.SetNoStore()
' Get a version of the Identity value that is cast as type
' PassportIdentity.
'<Snippet4>
'<Snippet5>
'<Snippet6>
Dim identity As PassportIdentity = Me.Context.User.Identity
' Determine whether the user is already signed in with a valid
' and current ticket. Passing -1 for the parameter values
' indicates the default values will be used.
If (identity.GetIsAuthenticated(-1, -1, -1)) Then
Me.Response.Write("Welcome to the site.<br /><br />")
' Print the Passport sign in button on the screen.
Me.Response.Write(identity.LogoTag2())
'</Snippet6>
' Make sure the user has core profile information before
' trying to access it.
If (identity.HasProfile("core")) Then
Me.Response.Write("<b>You have been authenticated as " & _
"Passport identity:" & identity.Name & "</b></p>")
End If
'</Snippet5>
' Determine whether the user has a ticket.
ElseIf identity.HasTicket Then
' If the user has a ticket but wasn't authenticated, that
' means the ticket is stale, so the login needs to be refreshed.
' Passing true as the fForceLogin parameter value indicates that
' silent refresh will be accepted.
identity.LoginUser(Nothing, -1, True, Nothing, -1, Nothing, _
-1, True, Nothing)
'</Snippet4>
' If the user does not already have a ticket, ask the user
' to sign in.
Else
Me.Response.Write("Please sign in using the link below.<br /><br />")
' Print the Passport sign in button on the screen.
Me.Response.Write(identity.LogoTag2())
End If
Catch comError As System.Runtime.InteropServices.COMException
Me.Response.Write("An error occurred while working with the " & _
"Passport SDK. The following result was returned: " & _
comError.ErrorCode)
End Try
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>ASP.NET Example</title>
</head>
<body>
<form id="form1" runat="server">
</form>
</body>
</html>
Remarques
Cette classe a été déconseillée et n’est plus prise en charge. Microsoft Passport Network a été remplacé par Windows Live ID.
S’applique à
LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)
Pour ouvrir la session utilisateur, génère une URL de redirection 302 ou lance un échange d'authentification de client sensible à Passport. Cette classe est déconseillée.
public:
int LoginUser(System::String ^ szRetURL, int iTimeWindow, int fForceLogin, System::String ^ szCOBrandArgs, int iLangID, System::String ^ strNameSpace, int iKPP, int iUseSecureAuth, System::Object ^ oExtraParams);
public int LoginUser (string szRetURL, int iTimeWindow, int fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, int iUseSecureAuth, object oExtraParams);
member this.LoginUser : string * int * int * string * int * string * int * int * obj -> int
Public Function LoginUser (szRetURL As String, iTimeWindow As Integer, fForceLogin As Integer, szCOBrandArgs As String, iLangID As Integer, strNameSpace As String, iKPP As Integer, iUseSecureAuth As Integer, oExtraParams As Object) As Integer
Paramètres
- szRetURL
- String
URL vers laquelle le serveur de connexion doit rediriger les utilisateurs à la fin de l'inscription. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iTimeWindow
- Int32
Valeur de temps exprimée en secondes. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- fForceLogin
- Int32
Indique si le serveur de connexion doit comparer le paramètre iTimeWindow
à la durée écoulée depuis la dernière inscription de l'utilisateur ou à l'heure de la dernière actualisation du ticket. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- szCOBrandArgs
- String
Chaîne spécifiant les variables à ajouter sous forme de chaîne de requête à l'URL de la page de script Cobranding Template du participant. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iLangID
- Int32
Identificateur de paramètres régionaux (LCID) spécifiant la langue dans laquelle afficher la page de connexion. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- strNameSpace
- String
Espace de noms de domaine vers lequel diriger les utilisateurs ne possédant pas de passeports pour s'inscrire. L'espace de noms spécifié doit apparaître en tant qu'entrée « nom de domaine » dans Partner.xml, document relatif à la configuration des composants. L'espace de noms par défaut est généralement « passport.com ». Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
- iKPP
- Int32
Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut. Ce paramètre n'est utile que lors de l'implémentation du service Kids Passport ; cependant, ce service ne prend pas encore en charge l'utilisation de cette méthode.
- iUseSecureAuth
- Int32
La connexion SSL n'est pas une option disponible sur les serveurs de connexion dans leur version actuelle. Les méthodes du Gestionnaire d'identités Passport incluent des paramètres de connexion SSL ; elles peuvent être requises pour des questions de syntaxe mais sont pour le moment ignorées par le serveur. Recherche des mises à jour de l'état de la connexion SSL sur le site web Passport. Passez -1 pour indiquer que Passport doit utiliser la valeur par défaut.
- oExtraParams
- Object
Paires nom-valeur à insérer directement dans l'en-tête d'authentification de Challenge, en particulier pour les interactions relatives aux authentifications sensibles à Passport. Passez null
pour indiquer que Passport doit utiliser la valeur par défaut.
Retours
Code de résultat sous forme d'entier.
Remarques
Cette classe a été déconseillée et n’est plus prise en charge. Microsoft Passport Network a été remplacé par Windows Live ID.