メインコンテンツへスキップ
Auth0テナントに複数のカスタムドメインが設定されている場合は、そのうちの 1 つをデフォルトのカスタムドメインとして指定できます。デフォルトドメインを設定すると、カスタムドメインが明示的に指定されていない場合でも、設定が簡素化され、一貫したユーザーエクスペリエンスを確保できます。

​
デフォルトのカスタムドメインとは何ですか？

デフォルトのカスタムドメインとは、Auth0 が次の用途で自動的に使用するカスタムドメインです。
  • メールおよび電話番号を使った通知: 特定のカスタムドメインが指定されていない場合に、パスワードリセットメール、メールアドレス確認リンク、その他の Auth0 によって生成される通知の送信に使用されます。これには、認証中に通知が送信されるケースも含まれます。
  • Management API 呼び出し: auth0-custom-domain ヘッダーなしで通知を発生させる API リクエストを処理する場合
正規のテナントドメイン (YOUR_TENANT.auth0.com または YOUR_TENANT.REGION.auth0.com) をデフォルトのカスタムドメインとして設定できます。テナントには、常にデフォルトのカスタムドメインが設定されます。

​
デフォルトドメインを設定する利点

デフォルトのカスタムドメインを設定すると、次のような利点があります。
  • 設定の簡素化: すべての Management API 呼び出しや設定で、カスタムドメインを毎回指定する必要がなくなります
  • 一貫したブランディング: 特定のドメインが指定されていない場合でも、ユーザーに常に自社ブランドを表示できます
  • auth0-custom-domain ヘッダーの任意化: Management API リクエストでカスタムドメインヘッダーの指定が任意になります
  • フォールバック動作: マルチブランドまたはマルチテナントの実装で、適切なデフォルト動作を提供します
  • 移行の容易化: 単一のカスタムドメインから複数のカスタムドメインへの移行を簡素化します

​
デフォルトドメインを設定する

Auth0 Dashboard または Management API を使用して、デフォルトのカスタムドメインを設定できます。

​
Auth0 Dashboard を使用する

Auth0 Dashboard でデフォルトのカスタムドメインを設定するには、次の手順を実行します。
  1. Auth0 Dashboard > ブランディング > Custom Domains に移動します
  2. 一覧から、デフォルトに設定する検証済みのカスタムドメインを探します
  3. 対象のドメインの Set as Default ボタンをクリックします
  4. 表示されたダイアログで操作を確定します
設定後、そのドメインにはカスタムドメイン一覧で “Default” バッジが表示されます。
デフォルトに設定できるのは、検証済みのカスタムドメインのみです。デフォルトとして指定する前に、カスタムドメインが完全に検証され、有効になっていることを確認してください。

​
Management API を使用する

Management API でデフォルトのカスタムドメインを設定するには、PATCH /api/v2/custom-domains/default エンドポイントを使用します。

​
デフォルトドメイン指定を削除する

カスタムドメインからデフォルト指定を削除するには、次のいずれかを実行します。
  1. 別のカスタムドメインをデフォルトに設定する (同時にデフォルトに設定できるドメインは 1 つだけです) 、または
  2. Management API を使用して、現在のデフォルトドメインの is_default を false に設定する
デフォルトに設定されたカスタムドメインがない場合、Auth0 は正規のテナントドメインを使用します。

​
デフォルトドメインの用途

​
メール通知

Auth0 がメール通知 (パスワードリセット、メールアドレス確認、ウェルカムメール) を送信する際、これらの通知内のリンクやカスタマイズにはデフォルトドメインが使用されます。メールテンプレートをカスタマイズすることで、“From” アドレス、件名、メール本文にカスタムドメインの情報を使用できます。

​
通知をトリガーする Management API エンドポイント

デフォルトのカスタムドメインは、メール通知または電話番号通知をトリガーする Management API エンドポイントで使用されます。デフォルトのドメインを設定している場合、これらのエンドポイントでは auth0-custom-domain ヘッダーは省略可能です。 メール通知をトリガーするエンドポイント:
  • POST /api/v2/tickets/password-change - パスワードリセットメールを送信します
  • POST /api/v2/tickets/email-verification - メールアドレス確認メールを送信します
  • POST /api/v2/jobs/verification-email - ユーザーに確認メールを送信します
  • POST /api/v2/users - 設定によってはウェルカムメールをトリガーできます
  • PATCH /api/v2/users/{id} - メールアドレスの更新時に確認メールをトリガーできます
電話番号通知をトリガーするエンドポイント:
  • POST /api/v2/users/{id}/phone/verification - SMS認証の確認コードを送信します
例: これらの通知エンドポイントで auth0-custom-domain ヘッダーを指定しない場合、Auth0 はメールまたは SMS 内のリンクやカスタマイズに、デフォルトのカスタムドメインを自動的に使用します。auth0-custom-domain ヘッダーを含めることで、リクエストごとにこれを上書きできます。

​
Actions でデフォルトドメインを使用する

Actions を使用して、カスタムドメインに応じたロジックを実装します。 
exports.onExecutePostLogin = async (event, api) => {
  const domain = event.custom_domain?.domain;

  // ログインドメインをユーザーメタデータに保存する
  if (domain) {
    api.user.setAppMetadata('login_domain', domain);
  }
};
Actions でカスタムドメイン情報を使用する方法の詳細については、複数のカスタムドメインを使用する Actions の統合を参照してください。

​
ベストプラクティス

デフォルトのカスタムドメインを設定する際は、次のベストプラクティスを参考にしてください。
  • 安定したドメインを選択する: デフォルトとして、頻繁に変更する必要のないドメインを選択します
  • 設定前に検証する: ドメインをデフォルトに設定する前に、検証が完了し、正常に動作していることを確認します
  • 決定内容を文書化する: 将来参照できるよう、特定のドメインをデフォルトとして選択した理由を記録します
  • メールフローをテストする: デフォルトドメインを設定した後、パスワードリセットとメールアドレス確認のフローをテストします
  • トークンの Issuer を確認する: デフォルトを設定した後、トークンの iss クレームが想定どおりの値であることを確認します
  • 複数ブランドのシナリオを想定する: 複数のブランドを提供している場合は、デフォルトとして汎用ドメインまたは管理用ドメインを選択します
  • 統合設定を更新する: 適切な統合設定を行えるよう、デフォルトドメインについてチームに周知します

​
詳細