LoginPassword

Universal Login の login-password 画面をカスタマイズするために利用できる、すべてのプロパティとメソッドについて説明します。

LoginPassword クラスは、login-password 画面の機能を実装します。この画面では、ユーザーの識別子とパスワードを入力します。

​

コンストラクター

LoginPassword 画面マネージャーのインスタンスを作成します。

Example

import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.login({
  username: "testUser",
  password: "testPassword"
});

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、ブランディング関連の構成情報を提供します。

client · ClientMembers

login-password 画面の id、name、logoUrl など、クライアント関連の構成情報を提供します。

organization · OrganizationMembers

id や name など、ユーザーの組織に関する情報を提供します。

prompt · PromptMembers

認証フロー内の現在のプロンプトに関するデータを含みます。

screen · ScreenMembersOnLoginPassword

構成やコンテキストを含む、login-password 画面固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータを含みます。

transaction · TransactionMembersOnLoginPassword

アクティブな識別子やフローの状態など、login-password 画面に固有のトランザクションデータを提供します。

untrustedData · UntrustedDataMembers

ログイン時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語はセッション中保持されます。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- で始まる追加のカスタムフィールドです (例: 'ulp-custom-field') 。

federatedLogin · Promise<void>

このメソッドは、認証のためにユーザーをソーシャルまたはエンタープライズのIDプロバイダー (IdP) にリダイレクトします。

Example

import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.federatedLogin({
  connection: "google-oauth2"
});

メソッドパラメーター

表示 パラメーター

options

FederatedLoginPayloadOptions。

connection · string · 必須

使用するソーシャル接続の名前です。

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーが存在しない場合は、空の配列を返します。

login · Promise<void>

このメソッドは、識別子と指定されたパスワードを使用してユーザーを認証します。

Example

import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.login({
  username: "testUser",
  password: "testPassword"
});

メソッドパラメーター

表示 パラメーター

options

LoginPayloadOptions。

username · string · 必須

ユーザーの識別子です。

password · string · 必須

ユーザーのパスワードです。

captcha? · string

キャプチャのcode、またはキャプチャプロバイダーからのレスポンスです。Auth0 テナントで Bot Detection が有効になっている場合、このプロパティは必須です。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- で始まる追加のカスタムフィールドです (例: 'ulp-custom-field') 。

switchConnection · Promise<void>

このメソッドは、データベース接続 (パスワード) とパスワードレス接続 (メールアドレス/SMS OTP) を切り替えます。

Example

import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.switchConnection({
  connection: "email"
});

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsLoginPassword。

connection · string · 必須

切り替え先の接続名です。パスワードレスには 'email' または 'sms' を使用し、パスワードベースの認証には DB 接続名を使用します。

[`key`: `string`] · "string" | "number" | "boolean"

ulp- で始まる追加のカスタムフィールドです (例: 'ulp-custom-field') 。