DomainTable コンポーネントは、お客様が Auth0 組織のメールドメインを管理するための一元的なインターフェイスを提供します。ドメイン所有権を確認すると、組織の管理者は Home Realm Discovery (HRD) などの重要な B2B 機能を有効にできるほか、メールアドレスのサフィックス (例: user@acme.com) に基づいて、ユーザーが適切な SSO プロバイダーに自動的にルーティングされるようになります。
- React
- Next.js
- shadcn
セットアップ要件
Auth0 の設定が必要です - テナントで
My Organization API が設定されていることを確認してください。セットアップガイドを参照
→
コンポーネントのインストール
いずれのコマンドを実行しても、共有ユーティリティと Auth0 統合 に必要な
依存関係である @auth0/universal-components-core もインストールされます。
はじめに
React SPA
完全な統合例
完全な統合例
Props
表示プロパティ
Display プロパティは、コンポーネントの動作に影響を与えずに、レンダリング方法を制御します。セクションを非表示にしたり、読み取り専用モードを有効にしたりする際に使用します。| プロパティ | 型 | 説明 |
|---|---|---|
readOnly | boolean | すべてのドメイン操作を無効にします。デフォルト: false |
hideHeader | boolean | ヘッダー セクションを非表示にします。デフォルト: false |
Action のプロパティ
Action propsはユーザーの操作を処理し、ユーザーがドメイン操作を実行した際の動作を定義します。ライフサイクルフック (onBefore、onAfter) を使用して、アプリケーションのルーティングや分析機能と統合できます。| プロパティ | 型 | 説明 |
|---|---|---|
createAction | ComponentAction<Domain> | ドメインを作成するアクション。 |
verifyAction | ComponentAction<Domain> | ドメインを検証するアクション。 |
deleteAction | ComponentAction<Domain> | ドメインを削除するアクション。 |
associateToProviderAction | ComponentAction<Domain, IdentityProvider> | ドメインをプロバイダーに関連付けるアクション。 |
deleteFromProviderAction | ComponentAction<Domain, IdentityProvider> | プロバイダーからドメインを削除するアクション。 |
onOpenProvider | (provider: IdentityProvider) => void | 設定モーダルからプロバイダーへ移動します。 |
onCreateProvider | () => void | プロバイダー作成フローに移動します。 |
ComponentAction<Domain>ドメイン作成フローを制御します。新しいドメインが追加されたタイミングを追跡するには、onAfter を使用します。プロパティ:disabled- 「ドメインを追加」ボタンを無効にしますonBefore(domain)- ドメインが作成される前に実行されます。作成を中止するにはfalseを返します (例: ドメインの形式が無効な場合) 。onAfter(domain)- ドメインの作成が正常に完了した後に実行されます。通知を表示したり、イベントを追跡したりするために使用します。
verifyActionType:
ComponentAction<Domain>ドメイン検証フローを制御します。ドメイン検証では、DNS TXTレコードを使用して所有権を証明します。プロパティ:disabled- Verify ボタンを無効化しますonBefore(domain)- 検証を試行する前に実行されます。falseを返すと検証を行いません (例: DNS が設定されていることを確認するため) 。onAfter(domain)- ドメインの検証が正常に完了した後に実行されます。成功通知を表示するために使用します。
deleteActionType:
ComponentAction<Domain>ドメインの削除を制御します。この操作は破壊的なため、確認には onBefore の使用を推奨します。プロパティ:disabled- 削除ボタンを無効化するonBefore(domain)- 削除前に実行されます。削除を防ぐにはfalseを返します (確認ダイアログでの使用を推奨) 。onAfter(domain)- ドメインが正常に削除された後に実行されます。このイベントの記録や通知の表示に使用します。
associateToProviderActionType:
ComponentAction<Domain, IdentityProvider>検証済みドメインをSSOプロバイダーに関連付ける操作を制御します。関連付けできるのは検証済みドメインのみです。プロパティ:disabled- 関連付けを無効にしますonBefore(domain, provider)- 関連付けの前に実行されます。関連付けを中止するにはfalseを返します。onAfter(domain, provider)- ドメインのプロバイダーへの関連付けが正常に完了した後に実行されます。
deleteFromProviderActionType:
ComponentAction<Domain, IdentityProvider>ドメインとSSOプロバイダーの関連付けを削除する操作を制御します。プロパティ:disabled- 関連付け解除アクションを無効にするonBefore(domain, provider)- 削除前に実行されます。削除を中止するにはfalseを返します。onAfter(domain, provider)- ドメインがプロバイダーから正常に削除されたあとに実行されます。
onOpenProvider / onCreateProviderType:
(provider: IdentityProvider) => void / () => voidドメイン設定モーダルのナビゲーションハンドラー。ユーザーがドメインのプロバイダー関連付けを設定する際:onOpenProvider- ユーザーが既存のプロバイダーをクリックして表示または編集すると呼び出されますonCreateProvider- ユーザーが新しいプロバイダーを作成するためにクリックしたときに呼び出されます
カスタマイズのプロパティ
カスタマイズ用プロパティを使用すると、ソースコードを変更せずに、ブランド、ロケール、検証要件に合わせてコンポーネントを調整できます。| プロパティ | 型 | 説明 |
|---|---|---|
schema | DomainTableSchema | ドメイン URL の検証ルール。 |
customMessages | Partial<DomainTableMainMessages> | i18n テキストの上書き。 |
styling | ComponentStyling | CSS 変数およびクラスの上書き。 |
利用可能なスキーマフィールド
利用可能なスキーマフィールド
create.domainUrl - ドメイン URL の検証 -
regex - カスタム正規表現パターンerrorMessage- カスタムエラーメッセージ
customMessagesすべてのテキストと翻訳をカスタマイズします。すべてのフィールドは省略可能で、指定しない場合はデフォルト値が使用されます。
利用可能なメッセージ
利用可能なメッセージ
スタイリングCSS変数とクラスのオーバーライドを使用して外観をカスタマイズします。テーマ対応のスタイリングをサポートします。
利用可能なスタイルオプション
利用可能なスタイルオプション
変数 - CSS カスタムプロパティ
common- すべてのテーマに適用light- ライトテーマのみdark- ダークテーマのみ
DomainTable-headerDomainTable-tableDomainTable-createModalDomainTable-configureModalDomainTable-deleteModal
高度なカスタマイズ
DomainTable コンポーネントは、より小さなサブコンポーネントとフックで構成されています。shadcn を使用している場合は、それらを個別にインポートしてカスタムドメインのワークフローを構築できます。利用可能なサブコンポーネント
高度なユースケースでは、個々のサブコンポーネントをインポートして、カスタムドメイン管理インターフェースを構築できます。これは、特定のモーダルをさまざまなコンテキストに埋め込む場合や、propsで設定できる範囲を超えてテーブルレイアウトをカスタマイズする場合に役立ちます。| コンポーネント | 説明 |
|---|---|
DomainCreateModal | ドメイン作成用のモーダル |
DomainVerifyModal | 検証フロー用のモーダル |
DomainDeleteModal | 削除確認用のモーダル |
DomainConfigureProvidersModal | プロバイダーの関連付けを管理 |
DomainTableActionsColumn | 各ドメイン行の操作ボタン |
利用可能なフック
これらのフックはUIを持たず、基盤となるロジックを提供します。Auth0 APIとの統合を活用しながら、完全にカスタムなインターフェースを構築できます。| Hook | 説明 |
|---|---|
useDomainTable | データ + API レイヤー (取得、作成、検証、削除、関連付け) |
useDomainTableLogic | UI の操作状態 + ハンドラー (モーダル、通知) |