LoginId

LoginId クラスは、login-id 画面の機能を実装します。この画面では、identifier 優先の認証フローの最初のステップとしてユーザーの identifier を収集します。テナントによっては、この identifier としてメールアドレス、電話番号、またはユーザー名を使用できます。パスキーログイン、フェデレーテッド ID プロバイダー、Google One Tap もサポートしています。

コンストラクタ

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

Example

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

プロパティ

BrandingMembers

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

ClientMembers

login-id 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

CountryCodesMembers

login-id 画面での電話番号入力用に、available や recommended などの国コードデータを提供します。

ExperimentMembers

この画面で現在アクティブな Experiment Center の experiment です。アクティブな experiment がない場合 (または画面が context_configuration でオプトインしていない場合) は null になります。

OrganizationMembers

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

PromptMembers

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

ScreenMembersOnLoginId

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

TenantMembers

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

TransactionMembersOnLoginId

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

UntrustedDataMembers

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

UserMembers

アクティブなユーザーの詳細 (username、email、roles など) を含みます。

メソッド

Promise<void>

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

Example

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

メソッドのパラメータ

表示パラメータ

LanguageChangeOptions。

string

必須

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

"session"

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

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

Example

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

メソッドのパラメータ

表示パラメータ

string

必須

ソーシャルまたはエンタープライズ IDプロバイダーの接続名です。

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

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

Error[]

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

このメソッドは、login-id 画面で有効になっている identifier タイプを取得します。

Example

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

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

Example

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

メソッドのパラメータ

表示パラメータ

LoginOptions。

string

ユーザーの identifier です。identifierType に応じて email、username、または電話番号になります。これまたは username を指定してください。両方を指定した場合は、identifier が優先されます。

string

元のスペルで指定するユーザーの identifier です。これまたは identifier を指定してください。

IdentifierType

identifier (または username) に格納される値の種類です。通常は screen.data.activeIdentifierType から読み取ります。identifier を型指定せずに送信する場合は省略してください。

string

電話番号の identifier に使用する ISO 3166-1 alpha-2 国コードです。countryCodes.available の code から指定します。identifierType が phone の場合は必須です。国内番号を渡してください。ダイヤルコードはサーバー側で先頭に付加されます。

string

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

"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();

メソッドのパラメータ

表示パラメータ

CustomOptions。

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

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

Promise<void>

このメソッドは、Google One Tap 認証情報を使用してユーザーを認証し、別の login ページにリダイレクトすることなくワンクリックでのサインインを可能にします。Google One Tap プロンプトを表示する前に screen.googleOneTapConfig を確認してください。この機能がサーバー側で有効になっていない場合は null です。

Example

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

メソッドのパラメータ

表示パラメータ

string

必須

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

Promise<void>

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

Example

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

Promise<void>

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

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);

メソッドパラメータ

表示パラメータ

string

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

auth0-acul-js

auth0-acul-react

auth0-android

auth0-php

コンストラクタ

プロパティ

メソッド

​コンストラクタ

​プロパティ

​メソッド

コンストラクタ

プロパティ

メソッド