PassportIdentity.LoginUser Метод

Ссылка

Определение

Пространство имен:: System.Web.Security

Сборка:: System.Web.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Осуществляет вход пользователя в систему, создавая перенаправление URL-адреса на 302 либо инициализируя обмен аутентификации для клиента, совместимого со службой Passport. Этот класс устарел.

Перегрузки

LoginUser()	Осуществляет вход пользователя в систему, создавая перенаправление URL-адреса на 302 либо инициализируя обмен аутентификации для клиента, совместимого со службой Passport. Этот класс устарел.
LoginUser(String)	Осуществляет вход пользователя в систему, создавая перенаправление URL-адреса на 302 либо инициализируя обмен аутентификации для клиента, совместимого со службой Passport. Этот класс устарел.
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)	Осуществляет вход пользователя в систему, создавая перенаправление URL-адреса на 302 либо инициализируя обмен аутентификации для клиента, совместимого со службой Passport. Этот класс устарел.
LoginUser(String, Int32, Int32, String, Int32, String, Int32, Int32, Object)	Осуществляет вход пользователя в систему, создавая перенаправление URL-адреса на 302 либо инициализируя обмен аутентификации для клиента, совместимого со службой Passport. Этот класс устарел.

LoginUser()

public:
 int LoginUser();

public int LoginUser ();

member this.LoginUser : unit -> int

Public Function LoginUser () As Integer

Возвращаемое значение

Int32

Целое число, представляющее код результата.

Применяется к

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

URL-адрес, по которому сервер входа должен перенаправить пользователя после завершения операции входа. Передайте значение null, чтобы указать, что служба Passport должна использовать значение по умолчанию.

Возвращаемое значение

Int32

Целое число, представляющее код результата.

Применяется к

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

iTimeWindow: Int32

Значение времени в секундах. Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию.

fForceLogin: Boolean

Значение true, чтобы сервер входа в систему сравнивал параметр iTimeWindow со значением времени последнего входа пользователя в систему; значение false, чтобы сервер входа в систему сравнивал параметр iTimeWindow со значением времени последнего обновления билета. Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию.

szCOBrandArgs: String

Строка, задающая переменные для добавления в качестве переменных строки запроса в URL-адрес страницы скрипта шаблона Cobranding участника. Передайте значение null, чтобы указать, что служба Passport должна использовать значение по умолчанию.

iLangID: Int32

Идентификатор языка (LCID), задающий язык, на котором следует отображать страницу входа в систему. Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию.

strNameSpace: String

Пространство имен домена, куда требуется направить пользователей без паспорта для регистрации. Заданное пространство имен должно отображаться в виде записи "имя домена" в документе Partner.xml конфигурации компонента. Обычно по умолчанию используется пространство имен "passport.com". Передайте значение null, чтобы указать, что служба Passport должна использовать значение по умолчанию.

iKPP: Int32

Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию. Этот параметр учитывается только при реализации службы Kids Passport; однако служба Kids Passport не поддерживает использование этого метода в данный момент.

fUseSecureAuth: Boolean

Вход SSL недоступен в качестве параметра в текущей версии серверов входа. Методы диспетчера паспорта включают параметры входа SSL, и они могут потребоваться для синтаксиса, но в настоящий момент сервер их не обрабатывает. Проверьте веб-сайт Passport на предмет обновления состояния входа SSL. Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию.

oExtraParams: Object

Пары "имя-значение", предназначенные для вставки в заголовок запроса аутентификации, особенно для совместимых со службой Passport взаимодействий аутентификации. Передайте значение null, чтобы указать, что служба Passport должна использовать значение по умолчанию.

Возвращаемое значение

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>

Применяется к

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

iTimeWindow: Int32

fForceLogin: Int32

Показывает, следует ли серверу входа производить сравнение параметра iTimeWindow со значением времени последнего входа пользователя в систему или со значением времени последнего обновления билета. Передайте значение -1, чтобы указать, что служба Passport должна использовать значение по умолчанию.

szCOBrandArgs: String

iLangID: Int32

strNameSpace: String

iKPP: Int32

iUseSecureAuth: Int32

oExtraParams: Object

Возвращаемое значение

Int32

Целое число, представляющее код результата.

Применяется к

Share via

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)

Параметры

Возвращаемое значение

Комментарии

Применяется к

Дополнительные ресурсы