PassportIdentity.LoginUser メソッド

リファレンス

定義

名前空間:: System.Web.Security

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

オーバーロード

LoginUser()	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。このクラスは非推奨とされます。
LoginUser(String)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。このクラスは非推奨とされます。
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。このクラスは非推奨とされます。
LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)	302 リダイレクト URL の生成、または Passport を認識するクライアント認証交換の実行によって、ユーザーをログオンします。このクラスは非推奨とされます。

注釈

このクラスは非推奨となり、サポートされなくなりました。 Microsoft Passport Network が Windows Live ID に置き換えられました。

LoginUser()

public:
 int LoginUser();

public int LoginUser ();

member this.LoginUser : unit -> int

Public Function LoginUser () As Integer

戻り値

Int32

整数の結果コード。

注釈

このクラスは非推奨となり、サポートされなくなりました。 Microsoft Passport Network が Windows Live ID に置き換えられました。

適用対象

LoginUser(String)

public:
 int LoginUser(System::String ^ strReturnUrl);

public int LoginUser (string strReturnUrl);

member this.LoginUser : string -> int

Public Function LoginUser (strReturnUrl As String) As Integer

パラメーター

strReturnUrl: String

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

戻り値

Int32

整数の結果コード。

注釈

このクラスは非推奨となり、サポートされなくなりました。 Microsoft Passport Network が Windows Live ID に置き換えられました。

適用対象

LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)

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

パラメーター

szRetURL: String

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

iTimeWindow: Int32

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

fForceLogin: Boolean

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

szCOBrandArgs: String

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

iLangID: Int32

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

strNameSpace: String

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

iKPP: Int32

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

fUseSecureAuth: Boolean

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

oExtraParams: Object

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

戻り値

Int32

整数の結果コード。

例

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

注釈

このクラスは非推奨となり、サポートされなくなりました。 Microsoft Passport Network が Windows Live ID に置き換えられました。

適用対象

LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)

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

パラメーター

szRetURL: String

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

iTimeWindow: Int32

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

fForceLogin: Int32

szCOBrandArgs: String

iLangID: Int32

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

strNameSpace: String

iKPP: Int32

iUseSecureAuth: Int32

oExtraParams: Object

戻り値

Int32

整数の結果コード。

注釈

このクラスは非推奨となり、サポートされなくなりました。 Microsoft Passport Network が Windows Live ID に置き換えられました。

適用対象

次の方法で共有

PassportIdentity.LoginUser メソッド

定義

オーバーロード

注釈

LoginUser()

戻り値

注釈

適用対象

LoginUser(String)

パラメーター

戻り値

注釈

適用対象

LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)

パラメーター

戻り値

例

注釈

適用対象

LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)

パラメーター

戻り値

注釈

適用対象

その他のリソース