PasskeyEnrollmentLocal

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

passkey-enrollment-local 画面は、ユーザーが現在使用しているデバイスでパスキーの登録を求められたときに表示されます。ユーザーはパスキーの登録を続行することも、中止して今後このプロンプトを表示しないようにすることもできます。

​

インポート

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

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

Import Example

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

// partialインポート
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>
  );
}

​

Context Hooks

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

このフックは、パスキー登録が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は 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

このフックは、アクティブな接続や現在のフローの state など、passkey-enrollment-local 画面における transaction 固有のデータを提供します。

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 の場合、このユーザーに対して今後のパスキー登録プロンプトを表示しません。

​

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

useAuth0Themes · フック

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

useChangeLanguage · フック

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

useCurrentScreen · フック

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

useErrors · フック

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