LoginId - Auth0 Docs

LoginId クラスは、login-id 画面の機能を実装します。この画面では、ユーザーの識別子とパスワードを収集します。テナントによっては、この識別子としてメールアドレス、電話番号、または username を使用できます。

コンストラクター

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

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.getLoginIdentifiers();

プロパティ

branding

BrandingMembers

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

client

ClientMembers

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

organization

OrganizationMembers

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

prompt

PromptMembers

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

screen

ScreenMembersOnLoginId

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

tenant

TenantMembers

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

transaction

TransactionMembersOnLoginId

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

untrustedData

UntrustedDataMembers

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

user

UserMembers

username、email、roles など、アクティブなユーザーの詳細です。

メソッド

changeLanguage

Promise<void>

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

Example

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

メソッドパラメーター

表示パラメーター

options

LanguageChangeOptions。

language

string

必須

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

persist?

"session"

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

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

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

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

Example

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

メソッドパラメーター

表示パラメーター

options

FederatedLoginPayloadOptions。

connection

string

必須

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

getErrors

Error[]

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

このメソッドは、login-id 画面で現在有効な識別子タイプを取得します。

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.getLoginIdentifiers();

このメソッドは、ユーザーに username の入力を求めます。

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.login({
  username: "testUser"
});

メソッドパラメーター

表示パラメーター

options

LoginOptions。

username

string

必須

ユーザーの識別子です。

captcha?

string

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

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

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

このメソッドは、指定されたパスキーを使用してユーザーを認証し、成功した場合は redirect_url にリダイレクトします。

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.passkeyLogin();

メソッドパラメーター

表示パラメーター

options

CustomOptions。

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

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

pickCountryCode

Promise<void>

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

Example

import LoginId from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();
loginIdManager.pickCountryCode();

メソッドパラメーター

表示パラメーター

options

CustomOptions。

[`key`: `string`]

"string" | "number" | "boolean" | "undefined"

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

registerPasskeyAutofill

Promise<void>

このメソッドは、mediation: conditional を指定した navigator.credentials.get() を使用して、パッシブな WebAuthn クレデンシャルリクエストを初期化します。サポートされている場合、ブラウザーは保存済みのパスキーを username フィールドのオートコンプリートドロップダウンに直接表示できます。

Example

import LoginId from '@auth0/auth0-acul-js/login-id';

async function initializeLogin() {
  const loginId = new LoginId();
  await loginId.registerPasskeyAutofill('username');
}

initializeLogin().catch(console.error);

メソッドパラメーター

表示パラメーター

inputId?

string

username <input> 要素の省略可能な ID (# なし) 。例: "username"。省略した場合、開発者が入力要素に正しい autocomplete 属性を手動で設定する必要があります。

​コンストラクター

​プロパティ

​メソッド

コンストラクター

プロパティ

メソッド