PasskeyEnrollment

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

PasskeyEnrollment クラスは、passkey-enrollment 画面の機能を提供します。この画面では、ユーザーは認証方法としてパスキーを登録できます。

​

コンストラクター

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

Example

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

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnPasskeyEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

abortPasskeyEnrollment · Promise<void>

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

Example

import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passkeyEnrollmentManager = new PasskeyEnrollment();
await passkeyEnrollmentManager.abortPasskeyEnrollment();

メソッドのパラメータ

表示 パラメータ

options

AbortEnrollmentOptions.

doNotShowAgain? · boolean

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

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメータ

表示 パラメータ

options

LanguageChangeOptions.

language · string · 必須

希望する言語のロケールコード (例: 'en'、'fr'、'es') 。

persist? · "session"

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

continuePasskeyEnrollment · Promise<void>

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

Example

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

getErrors · Error []

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