Muokkaa

Jaa

PassportIdentity.GetIsAuthenticated Method

  • Reference

Definition

Namespace:
System.Web.Security
Assembly:
System.Web.dll

Indicates whether the user is authenticated by a Passport authority. This class is deprecated.

Overloads

GetIsAuthenticated(Int32, Boolean, Boolean)

Indicates whether the user is authenticated by a central site responsible for Passport authentication. This class is deprecated.
GetIsAuthenticated(Int32, Int32, Int32)

Indicates whether the user is authenticated by a Passport authority. This class is deprecated.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

GetIsAuthenticated(Int32, Boolean, Boolean)

Indicates whether the user is authenticated by a central site responsible for Passport authentication. This class is deprecated.

public:
 bool GetIsAuthenticated(int iTimeWindow, bool bForceLogin, bool bCheckSecure);
public bool GetIsAuthenticated (int iTimeWindow, bool bForceLogin, bool bCheckSecure);
member this.GetIsAuthenticated : int * bool * bool -> bool
Public Function GetIsAuthenticated (iTimeWindow As Integer, bForceLogin As Boolean, bCheckSecure As Boolean) As Boolean

Parameters

iTimeWindow
Int32

Specifies the interval during which members must have last logged on to the calling domain. Pass -1 to indicate that Passport should use the default value.

bForceLogin
Boolean

Determines how the iTimeWindow parameter is used.

bCheckSecure
Boolean

Enables checking for an encrypted logon. SSL sign-in is not available as an option in the current version Login servers, so the value passed in is ignored at the server.

Returns

Boolean

true if the user is authenticated by a Passport authority; otherwise, false.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

Applies to

GetIsAuthenticated(Int32, Int32, Int32)

Indicates whether the user is authenticated by a Passport authority. This class is deprecated.

public:
 bool GetIsAuthenticated(int iTimeWindow, int iForceLogin, int iCheckSecure);
public bool GetIsAuthenticated (int iTimeWindow, int iForceLogin, int iCheckSecure);
member this.GetIsAuthenticated : int * int * int -> bool
Public Function GetIsAuthenticated (iTimeWindow As Integer, iForceLogin As Integer, iCheckSecure As Integer) As Boolean

Parameters

iTimeWindow
Int32

Specifies the interval during which members must have last logged on to the calling domain. A value of -1 indicates that Passport should use the default value, 0 represents false, and 1 represents true.

iForceLogin
Int32

Determines how the iTimeWindow parameter is used. A value of -1 indicates that Passport should use the default value, 0 represents false, and 1 represents true.

iCheckSecure
Int32

Enables checking for an encrypted logon. A value of -1 indicates that Passport should use the default value, 0 represents false, and 1 represents true.

A value of 10 or 100 for Passport version 2.1 Login servers specify SecureLevel 10 or 100 for the Passport Manager IsAuthenticated method. See the Passport version 2.1 SDK documentation for more information.

SSL sign-in is not available as an option for Passport version 1.4 Login servers. The value of iCheckSecure is ignored at the server.

Returns

Boolean

true if the user is authenticated by a central site responsible for Passport authentication; otherwise, false.

Examples

<!-- 
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.
-->


<!-- To view this code example in a fully-working sample, see the 
PassportIdentity Class topic. -->


<!-- To view this code example in a fully-working sample, see the 
PassportIdentity Class topic. -->


        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);
        }

        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)

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

Applies to