ログイン

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

Login クラスは、login 画面の機能を実装します。この画面では、ユーザーの識別子とパスワードを入力します。テナントによっては、この識別子はメールアドレス、電話番号、またはユーザー名になります。

​

コンストラクター

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

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

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' に設定すると、選択した言語はセッション中保持されます。

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

ulp- プレフィックスを持つ追加のカスタムフィールドです (例: 'ulp-custom-field') 。

federatedLogin · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

FederatedLoginPayloadOptions.

connection · string · 必須

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

getErrors · Error []

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

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

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

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

ulp- を接頭辞に持つ追加のカスタムフィールドです (例: 'ulp-custom-field') 。

pickCountryCode · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

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

ulp- 接頭辞が付いた追加のカスタムフィールド (例: 'ulp-custom-field') 。