PasskeyEnrollmentLocal

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

passkey-enrollment-local 画面は、ユーザーが現在使用中のデバイスでパスキー登録を求められたときに表示されます。ユーザーはパスキー登録を続行するか中止するかを選択でき、必要に応じて今後この確認が表示されないようにすることもできます。

​

インポート

各画面には、それぞれ固有のフックとメソッドがあります。SDK は各画面に対して、部分インポート と ルートインポート をサポートしています。

• 部分インポートを使うと、特定のユースケースに必要なコードだけを取り込めます。
• ルートインポートを使うと、単一のバンドルからすべての画面を読み込めるため、想定されるあらゆる画面に対応する統一されたビルドが必要な場合に便利です。

Import Example

// ルートインポート
import { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  usePasskeyEnrollmentLocal,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continuePasskeyEnrollment,
  abortPasskeyEnrollment,
} from '@auth0/auth0-acul-react/passkey-enrollment-local';

function PasskeyEnrollmentLocalScreen() {
  const { continuePasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => continuePasskeyEnrollment()}>Enroll Passkey</button>
  );
}

​

コンテキストフック

passkey-enrollment-local 画面で、Auth0 コンテキストデータへの読み取り専用アクセスを提供する画面スコープのフックです。@auth0/auth0-acul-react/passkey-enrollment-local からインポートします。

useBranding · () => BrandingMembers

このフックは、passkey-enrollment-local 画面に表示されるロゴ、色、テーマ設定などのブランディング構成を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

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

Example

import { useClient } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、パスキー登録が Organization スコープの場合に、ユーザーの Organization に関する情報を提供します。Organization コンテキストが存在しない場合は null を返します。

Example

import { useOrganization } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フローにおける現在のプロンプトに関するデータが含まれています。

Example

import { usePrompt } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnPasskeyEnrollmentLocal

このフックには、設定やコンテキストを含む passkey-enrollment-local 画面固有の詳細が含まれています。

Example

import { useScreen } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連するメタデータなど、テナントに関するデータが含まれています。

Example

import { useTenant } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフロー状態など、passkey-enrollment-local 画面に関するトランザクション固有のデータを提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL クエリ文字列から事前入力されたパラメータなど、画面に渡される信頼されていないデータを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在のユーザーの詳細を提供します。

Example

import { useUser } from '@auth0/auth0-acul-react/passkey-enrollment-local';
function UserProfile() {
  const user = useUser();
}

usePasskeyEnrollmentLocal · PasskeyEnrollmentLocalMembers

このフックは、passkey-enrollment-local 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

メソッド

continuePasskeyEnrollment · Promise<void>

このメソッドは、現在のデバイスでパスキー登録プロセスを開始し、認証フローを続行します。

Example

import { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react/passkey-enrollment-local';

function EnrollButton() {
  const { continuePasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => continuePasskeyEnrollment()}>
      Enroll Passkey
    </button>
  );
}

abortPasskeyEnrollment · Promise<void>

このメソッドは、パスキー登録プロセスをキャンセルし、パスキーを登録せずに認証フローを続行します。

Example

import { usePasskeyEnrollmentLocal } from '@auth0/auth0-acul-react/passkey-enrollment-local';

function SkipButton() {
  const { abortPasskeyEnrollment } = usePasskeyEnrollmentLocal();
  return (
    <button onClick={() => abortPasskeyEnrollment({ doNotShowAgain: true })}>
      Skip and Don't Ask Again
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

AbortEnrollmentOptions。

doNotShowAgain · boolean

true の場合、このユーザーに対して今後パスキー登録を促すメッセージは表示されません。

​

Common/Utility Hooks

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面で表示言語を変更する関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと状態を取得します。

useErrors · Hooks

このフックは、画面上のサーバーエラー、クライアントエラー、および開発者エラーを読み取り、管理します。