Login

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

Login クラスは、login 画面の機能を実装します。この画面では、ユーザーの識別子とパスワードを入力します。テナントの設定によっては、この識別子としてメールアドレス、電話番号、またはユーザー名を使用できます。また、フェデレーテッド ID プロバイダーおよび Google One Tap による認証もサポートしています。

​

コンストラクター

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

Example

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

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

認証フローにおける現在の prompt に関するデータを含みます。

screen · ScreenMembersOnLogin

設定やコンテキストを含む、login 画面固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembersOnLogin

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコード (例: 'en'、'fr'、'es') 。

persist? · "session"

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

federatedLogin · Promise<void>

このメソッドは、認証のためにユーザーを Social または Enterprise Identity Provider (IdP) にリダイレクトします。

Example

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

メソッドのパラメーター

表示 パラメーター

connection · string · 必須

Social または Enterprise Identity Provider の接続名。

getErrors · Error []

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

getLoginIdentifiers · ScreenIdentifierType [] | null

このメソッドは、login 画面で有効な識別子タイプを返します。

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.getLoginIdentifiers();

login · Promise<void>

このメソッドは、識別子と入力されたパスワードに基づいてユーザーを認証します。

Example

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

メソッドのパラメーター

表示 パラメーター

options

LoginPayloadOptions。

username · string · 必須

ユーザーを識別する値です。

password · string · 必須

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

captcha? · string

captcha コード、または CAPTCHA プロバイダーからのレスポンスです。Auth0 テナントで ボット検出 が有効になっている場合、このプロパティは必須です。

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

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

googleOneTap · Promise<void>

このメソッドは Google One Tap 認証情報を使用してユーザーを認証し、別のログインページにリダイレクトすることなくワンクリックでのサインインを可能にします。

Google One Tap プロンプトをレンダリングする前に screen.googleOneTapConfig を確認してください。この機能がサーバー側で有効になっていない場合、値は null です。

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.googleOneTap({ one_tap_credential: credential });

メソッドのパラメーター

表示 パラメーター

one_tap_credential · string · 必須

Google Identity Services のプロンプトから返される Google One Tap 認証情報トークン。

pickCountryCode · Promise<void>

このメソッドはユーザーを国番号の選択リストにリダイレクトし、そこで電話番号の国番号プレフィックスを更新できます。

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.pickCountryCode();