PasskeyEnrollment

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

passkey-enrollment 画面は、ユーザーがパスキーを認証方法として登録するよう求められた際に表示されます。この画面では、パスキーの登録を続行することも、処理を中止することもできます。

​

インポート

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

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

Import Example

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

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

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

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnPasskeyEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

usePasskeyEnrollment · PasskeyEnrollmentMembers

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

​

メソッド

continuePasskeyEnrollment · Promise<void>

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

Example

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

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

abortPasskeyEnrollment · Promise<void>

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

Example

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

function SkipButton() {
  const { abortPasskeyEnrollment } = usePasskeyEnrollment();
  return (
    <button onClick={() => abortPasskeyEnrollment()}>
      Skip for Now
    </button>
  );
}

doNotShowAgain · Promise<void>

このメソッドはパスキーの登録をスキップし、今後パスキー登録の案内を表示しないというユーザー設定を保存します。

Example

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

function DoNotShowAgainButton() {
  const { doNotShowAgain } = usePasskeyEnrollment();
  return (
    <button onClick={() => doNotShowAgain()}>
      Don't show this again
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者のエラーを取得して管理します。