This documentation is archived and is not being maintained.

PassportIdentity.LoginUser Method

Logs the user on, either by generating a 302 redirect URL or by initiating a Passport-aware client authentication exchange.

Overload List

Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange.

[Visual Basic] Overloads Public Function LoginUser() As Integer
[C#] public int LoginUser();
[C++] public: int LoginUser();
[JScript] public function LoginUser() : int;

Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange.

[Visual Basic] Overloads Public Function LoginUser(String) As Integer
[C#] public int LoginUser(string);
[C++] public: int LoginUser(String*);
[JScript] public function LoginUser(String) : int;

Logs the user on, either by generating a 302 redirect URL or by initiating a Passport-aware client authentication exchange.

[Visual Basic] Overloads Public Function LoginUser(String, Integer, Boolean, String, Integer, String, Integer, Boolean, Object) As Integer
[C#] public int LoginUser(string, int, bool, string, int, string, int, bool, object);
[C++] public: int LoginUser(String*, int, bool, String*, int, String*, int, bool, Object*);
[JScript] public function LoginUser(String, int, Boolean, String, int, String, int, Boolean, Object) : int;

Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange.

[Visual Basic] Overloads Public Function LoginUser(String, Integer, Integer, String, Integer, String, Integer, Integer, Object) As Integer
[C#] public int LoginUser(string, int, int, string, int, string, int, int, object);
[C++] public: int LoginUser(String*, int, int, String*, int, String*, int, int, Object*);
[JScript] public function LoginUser(String, int, int, String, int, String, int, int, Object) : int;

Example

[Visual Basic, C#] Note   This example shows how to use one of the overloaded versions of LoginUser. For other examples that might be available, see the individual overload topics.
[Visual Basic] 
<!-- 
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="VB" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Runtime.InteropServices" %>


<HTML>
    <HEAD>
        <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.SetCacheability(HttpCacheability.NoCache)
                    
                    ' Get a version of the Identity value that is cast as type
                    ' PassportIdentity. 
                    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())
                        ' 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
    
                    ' 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)

                    ' 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 occured while working with the " & _
                        "Passport SDK. The following result was returned: " & _
                        comError.ErrorCode)
                End Try
            End Sub
</SCRIPT>
    </HEAD>

    <body>
        <form runat="server">
        </form>
    </body>
</HTML>

[C#] 
<!-- 
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" %>
<HTML>
    <HEAD>
        <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.SetCacheability(HttpCacheability.NoCache); 


                    // Get a version of the Identity value that is cast as type
                    // PassportIdentity. 
                    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());
                        // 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>");
                        }
                    }
    
                    // 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);
                    }

                    // 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 occured while working with the " +
                        "Passport SDK.");
                }
            }
        </SCRIPT>
    </HEAD>
    <body>
        <form runat="server">
        </form>
    </body>
</HTML>

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

See Also

PassportIdentity Class | PassportIdentity Members | System.Web.Security Namespace

Show: