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 や関連するメタデータなど、tenant に関するデータを含みます。

transaction · TransactionMembers

アクティブな identifier やフローの状態など、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 []

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