This documentation is archived and is not being maintained.

PassportIdentity.GetIsAuthenticated Method

Indicates whether the user is authenticated by a Passport authority.

Overload List

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

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

Indicates whether the user is authenticated by a Passport authority.

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

Example

[Visual Basic, C#] Note   This example shows how to use one of the overloaded versions of GetIsAuthenticated. 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.
-->

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

    . . . 
                    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())

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

    . . . 
<!-- To view this code snippet in a fully-working example, 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());

[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: