Share via

Sys.Services AuthenticationService の login メソッド

  • [アーティクル]

更新 : 2007 年 11 月

ユーザーの資格情報を認証します。

Sys.Services.AuthenticationService.login(userName, password, isPersistent, customInfo, redirectUrl, loginCompletedCallback, failedCallback, userContext);

パラメータ

パラメータ

説明

userName

(必須) 認証するユーザー名。

password

ユーザーのパスワード。既定値は null です。

isPersistent

発行された認証チケットをブラウザ セッション間で永続的に保持する必要がある場合は true。それ以外の場合は false。既定値は false です。

redirectUrl

正常に認証されたときにブラウザのリダイレクト先となる URL。null の場合、リダイレクトは起こりません。既定値は null です。

customInfo

将来使用するために予約されています。既定値は null です。

loginCompletedCallback

ログインが正常に完了した場合に呼び出される関数。既定値は null です。

failedCallback

ログインが失敗したときに呼び出される関数。既定値は null です。

userContext

コールバック関数に渡すユーザー コンテキスト情報。

例外

例外の種類

条件

Sys.ArgumentNullException

username が null です。

解説

redirectUrl が null または空の文字列だった場合、認証 Web サービスの呼び出しが完了した後に、現在のページの表示は更新されません。代わりに、Web サービスの呼び出しが成功したときに、ログイン完了関数が呼び出されます。

redirectUrl が null でないか、空ではない文字列だった場合は、Web サービスが正常に呼び出された後に、ページは指定された URL にリダイレクトされます。リダイレクト URL の指定には、絶対仮想パス、相対仮想パス、完全修飾ドメイン名とパスのいずれかを使用できます。

Web サービスの呼び出しが失敗した場合、ページはリダイレクトも更新もされません。代わりに、失敗コールバック関数が呼び出されます。

使用例

login メソッドを使用してユーザーの資格情報をチェックする方法を次の例に示します。このコードは、Sys.Services.AuthenticationService クラスの概要で取り上げているコード例の一部分です。

// This function calls the login method of the
// authentication service to verify 
// the credentials entered by the user.
// If the credentials are authenticated, the
// authentication service issues a forms 
// authentication cookie. 
function OnClickLogin() 
{   

    // Set the default callback functions.
    SetDefaultLoginCompletedCallBack();
    SetDefaultLogoutCompletedCallBack();
    SetDefaultFailedCallBack();

    // Call the authetication service to authenticate
    // the credentials entered by the user.
    Sys.Services.AuthenticationService.login(username.value, 
        password.value, false,null,null,null,null,"User Context");
}

参照

概念

Sys.Services.ProfileService クラス

Sys.Net.WebServiceProxy クラス

参照

Sys.Services AuthenticationService の logout メソッド