SsoProviderEditコンポーネントは、シングルサインオンプロバイダーを編集するための統一されたインターフェースを提供します。
サードパーティアプリケーションアクセスとCross App Access
これらのコントロールは、Organization が SSO 接続に完全にアクセスできる場合にのみ表示されます。アクセスが制限されている接続では、両方のフィールドが非表示になります。use_for_third_party_client_access は、接続をサードパーティアプリケーションで使用できるようにします。Organization の third_party_client_access ポリシーが "block" に設定されている場合、このチェックボックスは表示されたまま無効化されます。Organization レベルでサードパーティアクセスを有効にするよう、まず管理者に求める説明メッセージが表示されます。
cross_app_access_resource_app は Cross App Access (XAA) を設定します。OIDC および Okta 接続では直接利用でき、SAML 接続では、事前に指定する必要がある OIDC ディスカバリー URL を介して利用できます。利用可否は GET /my-org/config/identity-providers によって制御されます。strategy の cross_app_access_resource_app 設定がない場合、このセクションは表示されません。
XAA は独立した認可経路であり、Organization レベルの third_party_client_access ポリシーと接続レベルの use_for_third_party_client_access 設定という、両方のサードパーティアクセス制御をバイパスします。
- React
- Next.js
- shadcn
設定要件
Auth0 Configuration が必要です—テナントで
My Organization API が設定されていることを確認してください。設定ガイドを表示
→
インストール
どちらのコマンドを実行しても、共有ユーティリティとAuth0連携に必要な@auth0/universal-components-coreの
依存関係もインストールされます。
はじめに
プロップ
必須プロップス
必須プロップスは、コンポーネントの動作に不可欠です。SsoProviderEdit では、対象のProviderを読み込んで編集するために、Provider IDが必要です。| プロパティ | 型 | 説明 |
|---|---|---|
providerId | string | 必須。 編集するSSO ProviderのID。 |
表示プロップス
表示用プロップスは、コンポーネントの動作に影響を与えることなく、レンダリング方法を制御します。| プロパティ | 型 | 説明 |
|---|---|---|
hideHeader | boolean | ヘッダーセクションを非表示にします。デフォルト: false |
hideProvisioningTab | boolean | プロビジョニング (SCIM) タブを非表示にします。デフォルト: false |
hideDeleteProvider | boolean | プロバイダーの削除アクションを非表示にします。デフォルト: false |
hideRemoveFromOrganization | boolean | Organizationから削除するアクションを非表示にします。デフォルト: false |
hideAttributeMappings | boolean | 属性マッピングセクションを非表示にします。デフォルト: false |
Action のプロップス
3つのタブにおけるユーザー操作は、各タブ名 (sso、provisioning、domains) の下に整理された複数のアクションプロップスで処理されます。| プロップス | 型 | 説明 |
|---|---|---|
backButton | Object | 戻るボタンの設定。 |
sso | SsoProviderTabEditProps | SSOタブのアクション。詳細 |
provisioning | SsoProvisioningTabEditProps | プロビジョニングタブのアクション。 詳細 |
domains | SsoDomainsTabEditProps | ドメインタブのアクション。詳細 |
{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }コンポーネントのヘッダーにある戻るボタンを設定します。このボタンを使用すると、プロバイダー一覧に戻ることができます。プロパティ:icon—カスタム Lucide アイコンコンポーネント (省略可。デフォルトは ArrowLeft)onClick—ナビゲーション用のクリックハンドラー
SSO タブのアクション
sso プロップは、SSO 設定タブの操作を構成します。このタブでは、プロバイダーの認証設定を管理します。| Action | タイプ | 説明 |
|---|---|---|
updateAction | ComponentAction<IdentityProvider, IdentityProvider> | プロバイダーの設定を更新します。 |
deleteAction | ComponentAction<IdentityProvider> | テナントからプロバイダーを完全に削除します。 |
deleteFromOrganizationAction | ComponentAction<IdentityProvider> | テナントから削除することなく、organization からプロバイダーを解除します。 |
ComponentAction<IdentityProvider, IdentityProvider>プロバイダー設定 (クライアントID、シークレット、証明書など) の変更を保存するかどうかを制御します。プロパティ:disabled—保存ボタンを無効にしますonBefore(provider)—更新前に実行されます。保存を中止するにはfalseを返します (たとえば、確認ダイアログを表示する場合) 。onAfter(provider, result)—Provider が正常に更新された後に実行されます。通知の表示やイベントの追跡に使用します。
sso.deleteAction型:
ComponentAction<IdentityProvider>Auth0 テナントからプロバイダーを完全に削除するかどうかを制御します。この操作は取り消せません。例:sso.deleteFromOrganizationAction型:
ComponentAction<IdentityProvider>プロバイダーを組織から削除する操作を制御します。プロバイダーは組織から切り離されますが、テナントには残り、後で再追加できます。例:プロビジョニングタブの操作
provisioningプロップは、SCIMプロビジョニングタブのアクションを設定します。このタブでは、SCIMプロトコルによるユーザーの自動プロビジョニングを管理します。| Action | 種類 | 説明 |
|---|---|---|
createAction | ComponentAction<IdentityProvider,
CreateIdPProvisioningConfigResponseContent> | SCIM プロビジョニングを有効化します。 |
deleteAction | ComponentAction<IdentityProvider> | SCIM プロビジョニングを無効化します。 |
createScimTokenAction | ComponentAction<IdentityProvider,
CreateIdpProvisioningScimTokenResponseContent> | SCIM トークンを生成します。 |
deleteScimTokenAction | ComponentAction<IdentityProvider> | SCIM トークンを取り消します。 |
ComponentAction<IdentityProvider, CreateIdPProvisioningConfigResponseContent>プロバイダーの SCIM プロビジョニングを有効にします。有効にすると、IDプロバイダーが使用する SCIM トークンを生成できます。例:provisioning.deleteAction型:
ComponentAction<IdentityProvider>SCIMプロビジョニングを無効にし、そのアイデンティティプロバイダーのすべてのプロビジョニング設定を削除します。例:provisioning.createScimTokenAction型:
ComponentAction<IdentityProvider, CreateIdpProvisioningScimTokenResponseContent>アイデンティティプロバイダーがAuth0で認証するための新しいSCIMベアラートークンを生成します。例:provisioning.deleteScimTokenAction型:
ComponentAction<IdentityProvider>SCIM トークンを取り消します。新しいトークンが生成されるまで、アイデンティティプロバイダーはユーザーを同期できなくなります。例:Domainsタブの操作
domains プロパティでは、ドメインタブのアクションを設定します。このタブでは、ユーザーの自動ルーティングのためにプロバイダーに関連付けられたドメインを管理します。| Action | 種類 | 説明 |
|---|---|---|
createAction | ComponentAction<Domain> | ドメインを追加します。 |
verifyAction | ComponentAction<Domain> | ドメインの所有権を確認します。 |
deleteAction | ComponentAction<Domain> | ドメインを削除します。 |
associateToProviderAction | ComponentAction<Domain, IdentityProvider | null> | ドメインをプロバイダーに関連付けます。 |
deleteFromProviderAction | ComponentAction<Domain, IdentityProvider | null> | プロバイダーからドメインを削除します。 |
ComponentAction<Domain>プロバイダー編集画面から組織に新しいドメインを追加できるかどうかを制御します。例:domains.verifyAction型:
ComponentAction<Domain>DNS TXTレコードによるドメイン検証を制御します。例:domains.deleteAction型:
ComponentAction<Domain>ドメインの削除を制御します。例:domains.associateToProviderAction型:
ComponentAction<Domain, IdentityProvider | null>検証済みドメインをこのSSOプロバイダーに関連付け、ユーザーを自動的にルーティングします。例:domains.deleteFromProviderAction型:
ComponentAction<Domain, IdentityProvider | null>このプロバイダーからドメインの関連付けを解除します。カスタマイズ用プロップス
カスタマイズ用プロップスを使用すると、ソースコードを変更せずに、ブランド、ロケール、バリデーションの要件に合わせてコンポーネントを調整できます。| プロパティ | 型 | 説明 |
|---|---|---|
schema | SsoProviderEditSchema | フィールドのバリデーションルール。 |
customMessages | Partial<SsoProviderEditMessages> | i18n テキストの上書き。 |
styling | ComponentStyling<SsoProviderEditClasses> | CSS 変数およびクラスの上書き。 |
利用可能なスキーマフィールド
利用可能なスキーマフィールド
すべてのschemaフィールドでサポートされる項目:
regex、errorMessage、minLength、maxLength、requiredprovider.*—strategyごとのProvider設定フィールド- 共通:
name、displayName - strategy固有のフィールド (SsoProviderCreateと同じ)
customMessagesすべてのテキストと翻訳をカスタマイズできます。すべてのフィールドは任意で、指定しない場合はデフォルト値が使用されます。
利用可能なメッセージ
利用可能なメッセージ
header—コンポーネントのヘッダー
title,back_button_text
tabs.sso.name—SSOタブのラベルtabs.sso.content—SSOタブのメッセージdetails.third_party_access—title,label,helper_textdetails.cross_app_access—title,label,helper_text,domain_verification_text,saml_description,saml_discovery_url_label,saml_discovery_url_placeholder,saml_discovery_url_helpertitle,descriptionfields.*—strategyごとのフォームフィールドラベルactions.save_button_text,actions.delete_button_textdelete_modal.*,remove_modal.*
tabs.provisioning.name—プロビジョニングタブのラベルtabs.domains.name—ドメインタブのラベル
title,descriptionscim_endpoint.label,scim_token.labelactions.enable_button_text,actions.disable_button_textactions.generate_token_button_text,actions.revoke_token_button_text
title,description- DomainTableメッセージと同じ構造
provider_update_success,provider_delete_successprovisioning_enable_success,provisioning_disable_successscim_token_create_success,scim_token_delete_success- ドメイン関連の通知
スタイリングCSS変数やクラスのオーバーライドで外観をカスタマイズできます。テーマ対応のスタイル設定をサポートします。
利用可能なスタイリングオプション
利用可能なスタイリングオプション
変数—CSS カスタムプロパティ
common—すべてのテーマに適用light—ライトテーマにのみ適用dark—ダークテーマにのみ適用
SsoProviderEdit-headerSsoProviderEdit-tabsProviderConfigure-ThirdPartyAccessProviderConfigure-CrossAppAccess
高度なカスタマイズ
利用可能なフック
これらのフックは、UIを介さずに基盤となるロジックを提供します。Auth0 API連携を活用して、独自のインターフェースを自由に構築できます。| Hook | 説明 |
|---|---|
useSsoProviderEdit | Providerの読み込みと更新処理 |
useSsoDomainTab | ドメインの関連付け管理 |