OrganizationDetailsEdit コンポーネントは、組織の詳細を編集するための統合インターフェースを提供します。
サードパーティアプリケーションのアクセス
third_party_client_access は Organizationレベルの設定で、サードパーティアプリケーションがOrganizationの SSO プロバイダーを通じてユーザーを認証できるかどうかを制御します。設定できる値は "allow" と "block" で、既定値は "block" です。
コンポーネントは GET /my-org/config を読み取り、テナントが許可している値を判断します。third_party_client_access.allowed_values に "block" のみが含まれる場合、ラジオグループは表示されるものの読み取り専用となり、Organizationの管理者は変更できません。両方の値が許可されている場合は、このフィールドを編集でき、Organization詳細リソースに保存されます。
この設定はOrganization全体に適用されるゲートとして機能します。Cross App Access (XAA) を構成するものではありません。XAA は SSO プロバイダーレベルで制御される別の認可経路です。
- React
- Next.js
- shadcn
設定の要件
Auth0 Configuration が必要です—tenant で
My Organization API が設定されていることを確認してください。設定ガイドを表示
→
インストール
どちらのコマンドを実行しても、共有ユーティリティとAuth0連携に必要な@auth0/universal-components-core
依存パッケージもインストールされます。
はじめに
プロップス
必須のプロップス
必須の props はコンポーネントの動作に不可欠です。OrganizationDetailsEdit には必須の props はなく、現在の組織の詳細を My Organization API から自動的に読み込みます。表示関連のプロップス
表示用のプロップスは、コンポーネントの動作に影響を与えることなく、その表示方法を制御します。セクションを非表示にしたり、読み取り専用モードを有効にしたりする際に使用します。| プロパティ | 型 | 説明 |
|---|---|---|
readOnly | boolean | すべてのフォーム入力を無効にします。デフォルト: false |
hideHeader | boolean | ヘッダーセクションを非表示にします。デフォルト: false |
Action のプロップス
Actionのプロップスはユーザー操作を処理し、ユーザーが変更を保存またはキャンセルしたときの動作を定義します。ライフサイクルフック (onBefore、onAfter) を使用すると、アプリケーションのルーティングや分析と連携できます。| プロパティ | 型 | 説明 |
|---|---|---|
saveAction | ComponentAction<OrganizationPrivate> | 変更を保存するアクション。 |
cancelAction | ComponentAction<OrganizationPrivate> | 変更をキャンセルまたは破棄するアクション。 |
backButton | Object | 戻るボタンの設定。 |
ComponentAction<OrganizationPrivate>ユーザーが organization の変更を送信した際の保存フローを制御します。保存の成功後に別の画面へ遷移させるには onAfter を使用します。プロパティ:disabled—保存ボタンを無効にします (たとえば、別の操作の実行中) 。onBefore(data)—保存処理の前に実行されます。保存を中止するにはfalseを返します (たとえば、先に確認ダイアログを表示する場合) 。onAfter(data)—organizationが正常に保存された後に実行されます。画面遷移やイベントの追跡に使用します。
cancelAction型:
ComponentAction<OrganizationPrivate>キャンセル/破棄のフローを制御します。破棄された変更の管理には、このアクションを使用します。プロパティ:disabled—キャンセルボタンを無効にしますonAfter(data)—キャンセルが確定した後に実行されます。Formから移動する際に使用します。
backButton型:
{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }コンポーネントのヘッダーにある戻るボタンを設定します。organization の概要ページや前のページに戻る導線として使用します。プロパティ:icon—カスタム Lucide アイコンコンポーネント (省略可、デフォルトは ArrowLeft)onClick—ナビゲーション用のクリックハンドラー
カスタマイズ用プロップス
カスタマイズ用のプロップスを使えば、ソースコードを変更せずに、ブランド、ロケール、バリデーションの要件に合わせてコンポーネントを調整できます。| プロパティ | 型 | 説明 |
|---|---|---|
schema | OrganizationDetailsEditSchemas | フィールドのバリデーションルール。 |
customMessages | Partial<OrganizationDetailsEditMessages> | i18n テキストの上書き。 |
styling | ComponentStyling<OrganizationEditClasses> | CSS 変数およびクラスの上書き。 |
利用可能なスキーマフィールド
利用可能なスキーマフィールド
すべてのschemaフィールドでサポートされる項目:
regex, errorMessage, minLength, maxLength, requireddetails.name—組織の内部名
details.displayName—組織の表示名
details.primaryColor—プライマリブランドカラー (16進数形式)
details.backgroundColor—ページの背景色 (16進数形式)
details.logoURL—ロゴのURLcustomMessagesすべてのテキストと翻訳をカスタマイズします。すべてのフィールドは任意で、指定されていない場合はデフォルトが使用されます。
利用可能なメッセージ
利用可能なメッセージ
header—コンポーネントヘッダー
title,back_button_text
titlefields.name—label,placeholder,helper_text,errorfields.display_name—label,placeholder,helper_text,errorfields.third_party_client_access—label,options.block.label,options.block.helper_text,options.allow.label,options.allow.helper_text
titlefields.logo—label,helper_text,errorfields.primary_color—label,helper_text,errorfields.page_background_color—label,helper_text,error
unsaved_changes_text,submit_button_label,cancel_button_label
save_organization_changes_message,organization_changes_error_message,organization_changes_error_message_generic
スタイリングCSS変数とクラスのオーバーライドで外観をカスタマイズできます。テーマに応じたスタイリングにも対応しています。
利用可能なスタイリングオプション
利用可能なスタイリングオプション
変数—CSS カスタムプロパティ
common—すべてのテーマに適用light—ライトテーマのみdark—ダークテーマのみ
OrganizationDetails_CardOrganizationDetails_FormActionsOrganizationDetails_SettingsDetailsOrganizationDetails_BrandingDetailsOrganizationDetails_ThirdPartyAccess
高度なカスタマイズ
利用可能なフック
これらのフックは、UIを持たない基盤ロジックのみを提供します。Auth0 APIとの連携を活用しつつ、完全に独自のインターフェースを構築したい場合にご利用ください。| Hook | 説明 |
|---|---|
useOrganizationDetailsEdit | 組織の編集ロジックとAPI連携 |