PassportIdentity.LoginUser メソッド ()

.NET Framework クラス ライブラリ リファレンス

PassportIdentity.LoginUser メソッド ()

302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Function LoginUser As
 Integer

Visual Basic (使用法)

Dim instance As PassportIdentity
Dim returnValue As Integer

returnValue = instance.LoginUser

C#

public int LoginUser ()

C++

public:
int LoginUser ()

J#

public int LoginUser ()

JScript

public function LoginUser () : int

戻り値
整数の結果コード。

解説

詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library/ja) で Passport SDK に関するドキュメントの IPassportManager2.LoginUser の説明を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
PassportIdentity クラス
PassportIdentity メンバ
System.Web.Security 名前空間

PassportIdentity.LoginUser メソッド (String, Int32, Int32, String, Int32, String, Int32, Int32, Object)

302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As PassportIdentity
Dim szRetURL As String
Dim iTimeWindow As Integer
Dim fForceLogin As Integer
Dim szCOBrandArgs As String
Dim iLangID As Integer
Dim strNameSpace As String
Dim iKPP As Integer
Dim iUseSecureAuth As Integer
Dim oExtraParams As Object
Dim returnValue As Integer

returnValue = instance.LoginUser(szRetURL, iTimeWindow, fForceLogin, szCOBrandArgs,
 iLangID, strNameSpace, iKPP, iUseSecureAuth, oExtraParams)

C#

public int LoginUser (
    string szRetURL,
    int iTimeWindow,
    int fForceLogin,
    string szCOBrandArgs,
    int iLangID,
    string strNameSpace,
    int iKPP,
    int iUseSecureAuth,
    Object oExtraParams
)

C++

public:
int LoginUser (
    String^ szRetURL, 
    int iTimeWindow, 
    int fForceLogin, 
    String^ szCOBrandArgs, 
    int iLangID, 
    String^ strNameSpace, 
    int iKPP, 
    int iUseSecureAuth, 
    Object^ oExtraParams
)

J#

public int LoginUser (
    String szRetURL, 
    int iTimeWindow, 
    int fForceLogin, 
    String szCOBrandArgs, 
    int iLangID, 
    String strNameSpace, 
    int iKPP, 
    int iUseSecureAuth, 
    Object oExtraParams
)

JScript

public function LoginUser (
    szRetURL : String, 
    iTimeWindow : int, 
    fForceLogin : int, 
    szCOBrandArgs : String, 
    iLangID : int, 
    strNameSpace : String, 
    iKPP : int, 
    iUseSecureAuth : int, 
    oExtraParams : Object
) : int

パラメータ

szRetURL

サインインの完了後に Login サーバーがユーザーをリダイレクトする場所の URL。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iTimeWindow

時刻値 (秒単位)。Passport に既定値を使用する場合、-1 を渡します。

fForceLogin

Login サーバーが、iTimeWindow パラメータの値をユーザーの最後にサインインした時間またはチケットの最後に更新された時間と比較するかどうかを示します。Passport に既定値を使用する場合、-1 を渡します。

szCOBrandArgs

参加要素のコブランディング テンプレート スクリプト ページの URL に、クエリ文字列変数として追加される変数を指定する文字列。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iLangID

ログイン ページを表示するときに使用する言語を指定するロケール識別子 (LCID: locale identifier)。Passport に既定値を使用する場合、-1 を渡します。

strNameSpace

Passport を登録せずにユーザーを転送する場所のドメイン名空間。指定した名前空間は、Partner.xml コンポーネント構成ドキュメント (CCD: Component Configuration Document) の "ドメイン名" エントリとして表示される必要があります。通常、既定の名前空間は "passport.com" です。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iKPP

Passport に既定値を使用する場合、-1 を渡します。このパラメータは、Kids Passport サービスを実装する場合にだけ使用されます。ただし、Kids Passport サービスは、現在このメソッドの使用をサポートしていません。

iUseSecureAuth

現在のバージョンの Login サーバーでは、SSL サインインはオプションとして利用できません。Passport マネージャのメソッドには、SSL サインイン パラメータがあります。このパラメータは構文上必要な場合がありますが、現在はサーバーでは無視されます。Passport Web サイトを SSL サインインの状態に更新するか確認してください。Passport に既定値を使用する場合、-1 を渡します。

oExtraParams

チャレンジ認証ヘッダーに直接挿入する名前と値の組み合わせ。具体的には、Passport を認識する認証との対話で使用します。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

戻り値
整数の結果コード。

解説

oExtraParams パラメータの現在の主な目的は cbtxt 変数の値を渡すことです。cbtxt は、Passport 対応アプリケーションの資格情報マネージャにあるダイアログで使用される、カスタマイズ可能なテキストを指定するために使用します。また、通常この認証は、Passport 認証を特定して識別するのに使用されます。cbtxt= の後に続く値は二重引用符で囲まれた文字列とします。たとえば、cbtxt= "Logon to Passport" のようになります。

詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library/ja) で Passport SDK に関するドキュメントの IPassportManager2.LoginUser の説明を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
PassportIdentity クラス
PassportIdentity メンバ
System.Web.Security 名前空間

PassportIdentity.LoginUser メソッド (String)

302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Function LoginUser ( _
    strReturnUrl As String _
) As Integer

Visual Basic (使用法)

Dim instance As PassportIdentity
Dim strReturnUrl As String
Dim returnValue As Integer

returnValue = instance.LoginUser(strReturnUrl)

C#

public int LoginUser (
    string strReturnUrl
)

C++

public:
int LoginUser (
    String^ strReturnUrl
)

J#

public int LoginUser (
    String strReturnUrl
)

JScript

public function LoginUser (
    strReturnUrl : String
) : int

パラメータ

strReturnUrl

サインインの完了後に Login サーバーがユーザーをリダイレクトする場所の URL。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

戻り値
整数の結果コード。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1

参照

関連項目
PassportIdentity クラス
PassportIdentity メンバ
System.Web.Security 名前空間

PassportIdentity.LoginUser メソッド

302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。
オーバーロードの一覧

名前	説明
PassportIdentity.LoginUser ()	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。
PassportIdentity.LoginUser (String)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。
PassportIdentity.LoginUser (String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。
PassportIdentity.LoginUser (String, Int32, Int32, String, Int32, String, Int32, Int32, Object)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。

参照

関連項目

PassportIdentity クラス
PassportIdentity メンバ
System.Web.Security 名前空間

PassportIdentity.LoginUser メソッド (String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)

302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As PassportIdentity
Dim szRetURL As String
Dim iTimeWindow As Integer
Dim fForceLogin As Boolean
Dim szCOBrandArgs As String
Dim iLangID As Integer
Dim strNameSpace As String
Dim iKPP As Integer
Dim fUseSecureAuth As Boolean
Dim oExtraParams As Object
Dim returnValue As Integer

returnValue = instance.LoginUser(szRetURL, iTimeWindow, fForceLogin, szCOBrandArgs,
 iLangID, strNameSpace, iKPP, fUseSecureAuth, oExtraParams)

C#

public int LoginUser (
    string szRetURL,
    int iTimeWindow,
    bool fForceLogin,
    string szCOBrandArgs,
    int iLangID,
    string strNameSpace,
    int iKPP,
    bool fUseSecureAuth,
    Object oExtraParams
)

C++

public:
int LoginUser (
    String^ szRetURL, 
    int iTimeWindow, 
    bool fForceLogin, 
    String^ szCOBrandArgs, 
    int iLangID, 
    String^ strNameSpace, 
    int iKPP, 
    bool fUseSecureAuth, 
    Object^ oExtraParams
)

J#

public int LoginUser (
    String szRetURL, 
    int iTimeWindow, 
    boolean fForceLogin, 
    String szCOBrandArgs, 
    int iLangID, 
    String strNameSpace, 
    int iKPP, 
    boolean fUseSecureAuth, 
    Object oExtraParams
)

JScript

public function LoginUser (
    szRetURL : String, 
    iTimeWindow : int, 
    fForceLogin : boolean, 
    szCOBrandArgs : String, 
    iLangID : int, 
    strNameSpace : String, 
    iKPP : int, 
    fUseSecureAuth : boolean, 
    oExtraParams : Object
) : int

パラメータ

szRetURL

サインインの完了後に Login サーバーがユーザーをリダイレクトする場所の URL。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iTimeWindow

時刻値 (秒単位)。Passport に既定値を使用する場合、-1 を渡します。

fForceLogin

Login サーバーが iTimeWindow パラメータ値とユーザーの最後にサインインした時刻を比較する場合は true。Login サーバーが iTimeWindow の値とチケットの最後に更新された時刻を比較する場合は false。Passport に既定値を使用する場合、-1 を渡します。

szCOBrandArgs

参加要素のコブランディング テンプレート スクリプト ページの URL に、クエリ文字列変数として追加される変数を指定する文字列。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iLangID

ログイン ページを表示するときに使用する言語を指定するロケール識別子 (LCID: locale identifier)。Passport に既定値を使用する場合、-1 を渡します。

strNameSpace

Passport を登録せずにユーザーを転送する場所のドメイン名空間。指定した名前空間は、Partner.xml コンポーネント構成ドキュメント (CCD: Component Configuration Document) の "ドメイン名" エントリとして表示される必要があります。通常、既定の名前空間は "passport.com" です。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

iKPP

Passport に既定値を使用する場合、-1 を渡します。このパラメータは、Kids Passport サービスを実装する場合にだけ使用されます。ただし、Kids Passport サービスは、現在このメソッドの使用をサポートしていません。

fUseSecureAuth

現在のバージョンの Login サーバーでは、SSL サインインはオプションとして利用できません。Passport マネージャのメソッドには、SSL サインイン パラメータがあります。このパラメータは構文上必要な場合がありますが、現在はサーバーでは無視されます。Passport Web サイトを SSL サインインの状態に更新するか確認してください。Passport に既定値を使用する場合、-1 を渡します。

oExtraParams

チャレンジ認証ヘッダーに直接挿入する名前と値の組み合わせ。具体的には、Passport を認識する認証との対話で使用します。Passport に既定値を使用する場合、null 参照 (Visual Basic では Nothing) を渡します。

戻り値
整数の結果コード。

解説

oExtraParams パラメータの現在の主な目的は cbtxt 変数の値を渡すことです。cbtxt は、Passport 対応アプリケーションの資格情報マネージャにあるダイアログで使用される、カスタマイズ可能なテキストを指定するために使用します。また、通常この認証は、Passport 認証を特定して識別するのに使用されます。cbtxt= の後に続く値は二重引用符で囲まれた文字列とします。たとえば、cbtxt= "Logon to Passport" のようになります。

詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library/ja) で Passport SDK に関するドキュメントの IPassportManager2.LoginUser の説明を参照してください。

使用例

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

<br /><span space="preserve">...</span><br
 /><%@ 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.
-->

<br /><span space="preserve">...</span><br /><%@
 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>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
PassportIdentity クラス
PassportIdentity メンバ
System.Web.Security 名前空間