セットアップの要件
Auth0の構成が必要 - テナントがMy Organization APIで構成されていることを確認してください。セットアップガイドを表示
→
インストール
shadcnコマンドを実行すると、共有ユーティリティとAuth0統合の@auth0/universal-components-core依存関係もインストールされます。
クイックスタート
完全な統合の例
完全な統合の例
Props
Core Props
Core propsは、コンポーネントの操作の基礎です。SsoProviderCreateの場合、プロバイダーの作成後を制御するcore propは1つだけです。
| Prop | 種類 | 説明 |
|---|---|---|
createAction | ComponentAction<...> | 必須。 作成後のフローを制御します。詳細 |
createAction
種類:ComponentAction<CreateIdentityProviderRequestContentPrivate, IdentityProvider>
createAction propは、プロバイダーが作成された後のユーザーの移動先を制御するため、必須です。これがないと、コンポーネントは次の動作がわかりません。
プロパティ:
disabled- [作成]ボタンを無効にします(たとえば、別の処理が進行中の場合)onBefore(data)- プロバイダーの作成前に実行します。作成を防ぐ場合はfalseを返します(確認のダイアログを表示する場合など)。onAfter(data, result)- プロバイダーが作成された後で実行します。別のページに移動する場合、またはイベントを追跡する場合に使用します。
Display Props
Display propsは、コンポーネントのレンダリングを制御します。その動作に影響することはありません。セクションを非表示にする場合、または読み取り専用モードを有効にする場合に使用します。| Prop | 種類 | 説明 |
|---|---|---|
readOnly | boolean | すべてのフォームの入力を無効にします。デフォルト値:false |
hideHeader | boolean | ヘッダーセクションを非表示にします。デフォルト値:false |
Action Props
Action propsは、主要な作成フローに限らないユーザーインタラクションを処理するもので、ナビゲーションやウィザードステップの動作を制御します。backButton
種類:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }
コンポーネントヘッダー内の[戻る]ボタンを構成します。これを使ってプロバイダーリストまたは前のページに戻ります。
プロパティ:
icon- Lucide iconのカスタムコンポーネント(任意、デフォルト値はArrowLeft)onClick- ナビゲーション用クリックハンドラー
onNext / onPrevious
種類:(stepId: string, values: Partial<SsoProviderFormValues>) => boolean
ウィザードのステップナビゲーションを制御します。これらのコールバックは、ユーザーが[次へ]または[前へ]をクリックしたときに呼び出されます。ナビゲーションを防ぐ場合はfalseを返します。
ユースケース:
- 続行する前にステップデータを検証
- 分析をログに記録してステップを完了
- ステップを条件付きでスキップ
stepId- 現在のステップ識別子("provider-select","provider-details","provider-configure")values- 現在のフォーム値
Customization Props
Customization propsを使うと、ソースコードに変更を加えることなく、コンポーネントをブランド・ロケール・検証要件に合わせることができます。schema
プロバイダーフィールド用のカスタム検証ルールを設定します。ルールは、プロバイダーストラテジー別に整理されます(使用される認証プロトコルは、oidc、samlp、waad、google-apps、adfs、pingfederate、oktaなど)。すべてのフィールドがregex、errorMessage、minLength、maxLength、requiredをサポートします。
利用可能なスキーマフィールド
利用可能なスキーマフィールド
プロバイダーの詳細
name,displayName
okta.domain,okta.client_id,okta.client_secret,okta.icon_url,okta.callback_url
adfs.meta_data_source,adfs.meta_data_location_url,adfs.adfs_server,adfs.fedMetadataXml
google-apps.domain,google-apps.client_id,google-apps.client_secret,google-apps.icon_url,google-apps.callback_url
oidc.type,oidc.client_id,oidc.client_secret,oidc.discovery_url,oidc.isFrontChannel
pingfederate.signatureAlgorithm,pingfederate.digestAlgorithm,pingfederate.signSAMLRequest,pingfederate.metadataUrl,pingfederate.signingCert,pingfederate.idpInitiated,pingfederate.icon_url
samlp.meta_data_source,samlp.single_sign_on_login_url,samlp.signatureAlgorithm,samlp.digestAlgorithm,samlp.protocolBinding,samlp.signSAMLRequest,samlp.bindingMethod,samlp.metadataUrl,samlp.cert,samlp.idpInitiated,samlp.icon_url
waad.domain,waad.client_id,waad.client_secret,waad.icon_url,waad.callback_url
customMessages
すべてのテキストと翻訳をカスタマイズします。フィールドはすべて任意で、入力しなかった場合はデフォルト値が使用されます。利用可能なメッセージ
利用可能なメッセージ
styling
CSS変数とクラスのオーバーライドを使って外観をカスタマイズします。テーマ認識型のスタイルをサポートします。利用可能なスタイリングオプション
利用可能なスタイリングオプション
Variables - CSSカスタムプロパティ
common- すべてのテーマに適用light- ライトテーマのみdark- ダークテーマのみ
SsoProviderCreate-headerSsoProviderCreate-wizardProviderSelect-rootProviderDetails-rootProviderConfigure-root
高度なカスタマイズ
SsoProviderCreateコンポーネントは、小さいサブコンポーネントとフックで構成されます。shadcnを使用する場合は、個別にインポートしてカスタムのSSOプロバイダー作成ワークフローを構築できます。
利用可能なサブコンポーネント
高度なユースケースの場合は、個々のサブコンポーネントをインポートしてカスタムのSSOプロバイダー作成ワークフローを構築できます。これは、1つのステップを異なるUIに埋め込む必要がある場合や、propsで可能な範囲を超えてウィザードフローをカスタマイズする必要がある場合に便利です。| コンポーネント | 説明 |
|---|---|
ProviderSelect | プロバイダーアイコンを使ったストラテジー選択ステップ |
ProviderDetails | 名前と表示名の構成ステップ |
ProviderConfigure | ストラテジー固有の構成ステップ |
ProviderConfigureFields | ストラテジーに基づく動的フォームフィールド |
OktaProviderForm | Okta固有の構成フォーム |
AdfsProviderForm | ADFS固有の構成フォーム |
GoogleAppsProviderForm | Google Workspace固有の構成フォーム |
OidcProviderForm | OIDC固有の構成フォーム |
PingFederateProviderForm | PingFederate固有の構成フォーム |
SamlpProviderForm | SAML固有の構成フォーム |
WaadProviderForm | Azure AD固有の構成フォーム |
Wizard | マルチステップウィザードのUI |
利用可能なフック
これらのフックは、UIなしで基盤となるロジックを提供します。フックを使用することで、Auth0 API統合を活用しながら、完全にカスタムのインターフェイスを構築できます。| フック | 説明 |
|---|---|
useSsoProviderCreate | プロバイダー作成ロジックとAPIの統合 |