> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# PasskeyEnrollment
> Universal Login の `passkey-enrollment` 画面をカスタマイズするために使用できる、すべてのフックとメソッドについて説明します。
`passkey-enrollment` 画面は、ユーザーが認証方法としてパスキーを登録するよう求められたときに表示されます。この画面では、ユーザーはパスキー登録を続行するか、処理を中止できます。
## インポート
各画面には、それぞれ独自のフックとメソッドのセットがあります。SDK は、各画面で**部分インポート**と**ルートインポート**をサポートしています。
* 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
* ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めます。これは、考えられるすべての画面に対応する統一ビルドが必要な場合に便利です。
```jsx Import Example theme={null}
// ルートインポート
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 (
continuePasskeyEnrollment()}>Enroll Passkey
);
}
```
## コンテキストフック
`passkey-enrollment` 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。`@auth0/auth0-acul-react/passkey-enrollment` からインポートします。
() => BrandingMembers }>
このフックは、`passkey-enrollment` 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/passkey-enrollment';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers }>
このフックは、`passkey-enrollment` 画面に対応する `id`、`name`、`logoUrl` などのクライアント関連設定を提供します。
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/passkey-enrollment';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers }>
このフックは、パスキー登録が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は `null` を返します。
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/passkey-enrollment';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return No Organization context
;
}
}
```
() => PromptMembers }>
このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/passkey-enrollment';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnPasskeyEnrollment }>
このフックには、設定やコンテキストなど、`passkey-enrollment` 画面固有の詳細が含まれます。
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/passkey-enrollment';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers }>
このフックには、`id` や関連するメタデータなど、テナントに関するデータが含まれます。
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/passkey-enrollment';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembers }>
このフックは、アクティブな接続や現在のフロー状態など、`passkey-enrollment` 画面に固有のトランザクションデータを提供します。
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/passkey-enrollment';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers }>
このフックは、URL のクエリ文字列から事前入力されたパラメーターなど、画面に渡される信頼できないデータを扱います。
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/passkey-enrollment';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers }>
このフックは、`username`、`email`、利用可能な認証方法など、現在のユーザーの情報を提供します。
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/passkey-enrollment';
function UserProfile() {
const user = useUser();
}
```
PasskeyEnrollmentMembers}>
このフックは、`passkey-enrollment` 画面で利用できるすべてのメソッドとコンテキストを返します。
## メソッド
このメソッドはパスキー登録を開始し、認証フローを続行します。
```jsx Example theme={null}
import { usePasskeyEnrollment } from '@auth0/auth0-acul-react/passkey-enrollment';
function EnrollButton() {
const { continuePasskeyEnrollment } = usePasskeyEnrollment();
return (
continuePasskeyEnrollment()}>
Enroll Passkey
);
}
```
このメソッドはパスキー登録を中止し、パスキーを登録せずに認証フローを続行します。
```jsx Example theme={null}
import { usePasskeyEnrollment } from '@auth0/auth0-acul-react/passkey-enrollment';
function SkipButton() {
const { abortPasskeyEnrollment } = usePasskeyEnrollment();
return (
abortPasskeyEnrollment()}>
Skip for Now
);
}
```
このメソッドはパスキー登録をスキップし、今後パスキー登録を求める表示を行わないというユーザー設定を保存します。
```jsx Example theme={null}
import { usePasskeyEnrollment } from '@auth0/auth0-acul-react/passkey-enrollment';
function DoNotShowAgainButton() {
const { doNotShowAgain } = usePasskeyEnrollment();
return (
doNotShowAgain()}>
Don't show this again
);
}
```
## 共通/ユーティリティフック
useAuth0Themes} type="Hooks">
このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
useChangeLanguage} type="Hooks">
このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。
useCurrentScreen} type="Hooks">
このフックは、現在の画面のコンテキストと state を取得します。
useErrors} type="Hooks">
このフックは、画面上のサーバーエラー、クライアントエラー、開発者エラーを読み取り、管理します。
