PasskeyEnrollmentLocal

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

PasskeyEnrollmentLocal クラスは、passkey-enrollment-local 画面の機能を実装します。この画面では、ユーザーはデバイスにローカルに保存されたパスキーを認証方法として登録できます。

​

コンストラクター

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

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
await passkeyEnrollmentLocalManager.continuePasskeyEnrollment();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnPasskeyEnrollmentLocal

構成やコンテキストなど、passkey-enrollment-local 画面に固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

パスキー登録フロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細が含まれます。

​

メソッド

abortPasskeyEnrollment · Promise<void>

このメソッドは、パスキー登録プロセスを中止します。

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
await passkeyEnrollmentLocalManager.abortPasskeyEnrollment({ doNotShowAgain: true });

メソッドパラメーター

表示 パラメーター

options

AbortEnrollmentOptions。

doNotShowAgain? · boolean

true に設定すると、以降のセッションでパスキー登録のプロンプトを表示しません。

changeLanguage · Promise<void>

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

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
passkeyEnrollmentLocalManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continuePasskeyEnrollment · Promise<void>

このメソッドは、パスキー登録プロセスを続行します。

Example

import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passkeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();
await passkeyEnrollmentLocalManager.continuePasskeyEnrollment();

getErrors · Error []

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