> ## 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.
# MfaBeginEnrollOptions
> Universal Login の `mfa-begin-enroll-options` 画面をカスタマイズするために使用できる、すべてのHooksとメソッドについて説明します。
`mfa-begin-enroll-options` 画面では、利用可能な多要素認証の登録オプションがユーザーに表示され、登録する認証要素を選択できます。
## インポート
各画面には、それぞれ固有のHooksとメソッドのセットがあります。SDK は各画面で **部分インポート** と **ルートインポート** をサポートしています。
* 部分インポート を使うと、特定のユースケースに必要なコードだけを含めることができます。
* ルートインポート を使うと、単一のバンドルからすべての画面を読み込めるため、想定されるあらゆる画面に対応する統一ビルドが必要な場合に便利です。
```jsx Import Example theme={null}
// ルートインポート
import { useMfaBeginEnrollOptions } from '@auth0/auth0-acul-react';
// 部分インポート
import {
useMfaBeginEnrollOptions,
// コンテキストHooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// 共通Hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
// ユーティリティHooks
useChangeLanguage,
// メソッド
enroll,
} from "@auth0/auth0-acul-react/mfa-begin-enroll-options";
function MfaBeginEnrollOptionsScreen() {
const { enroll } = useMfaBeginEnrollOptions();
return (
enroll({ action: 'otp' })}>
Enroll with Authenticator App
);
}
```
## Context Hooks
`mfa-begin-enroll-options` 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのHooksです。`@auth0/auth0-acul-react/mfa-begin-enroll-options` からインポートします。
() => BrandingMembers }>
このフックは、`mfa-begin-enroll-options` 画面に表示されるロゴ、色、テーマ設定などのブランド設定を提供します。
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers }>
このフックは、`mfa-begin-enroll-options` 画面で使用される `id`、`name`、`logoUrl` などのクライアント関連の設定を提供します。
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers }>
このフックは、MFA の enrollment が組織 スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は `null` を返します。
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return No organization context
;
}
}
```
() => PromptMembers }>
このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembers }>
このフックには、設定やコンテキストを含む `mfa-begin-enroll-options` 画面固有の詳細が含まれます。
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers }>
このフックには、`id` や関連するメタデータなど、テナントに関するデータが含まれます。
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembers }>
このフックは、利用可能な MFA 認証要素や現在のフロー状態など、`mfa-begin-enroll-options` 画面に関する transaction 固有のデータを提供します。
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers }>
このフックは、URLパラメーターから事前入力された値など、画面に渡される信頼できないデータを扱います。
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers }>
このフックは、`username`、`email`、利用可能な認証方法など、現在のユーザーの詳細を提供します。
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function UserProfile() {
const user = useUser();
}
```
MfaBeginEnrollOptionsMembers}>
このフックは、`mfa-begin-enroll-options` 画面で利用できるすべてのメソッドとコンテキストを返します。
## メソッド
このメソッドは、選択したMFA認証要素の登録を開始し、その認証要素の登録画面へフローを進めます。
```jsx Example theme={null}
import { useMfaBeginEnrollOptions } from '@auth0/auth0-acul-react/mfa-begin-enroll-options';
function EnrollOptions() {
const { enroll } = useMfaBeginEnrollOptions();
return (
enroll({ action: 'otp' })}>
認証器アプリで登録
);
}
```
**メソッドパラメータ**
[MfaEnrollOptions](/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions)。
登録する認証要素を指定する action です。"push-notification"、"otp"、"sms"、"phone"、"voice"、"webauthn-roaming" のいずれかです。
## 共通/ユーティリティ Hooks
useAuth0Themes} type="Hooks">
このフックは、ブランディングのコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
useChangeLanguage} type="Hooks">
このフックは、現在の ACUL 画面で表示言語を変更する関数を返します。
useCurrentScreen} type="Hooks">
このフックは、現在の画面のコンテキストと状態を取得します。
useErrors} type="Hooks">
このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取り、管理します。
