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>
  );
}

​

コンテキストフック

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

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

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>
  );
}

​

共通/ユーティリティフック

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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