移行シナリオ
移行前チェックリスト
- すべての新しいカスタムドメインのドメイン所有権を確認している
- 現在の認証プロセスと API 連携を確認している
- 現在のドメインを使用しているすべてのアプリケーションを特定している
- 現在のメールテンプレートとリンクを文書化している
- SSL/TLS 証明書を取得している (自己管理証明書を使用している場合)
- 開発環境またはステージング環境で、新しいカスタムドメインの設定をテストしている
- ロールバック計画を準備している
- トラフィックの少ない時間帯に移行を予定している (該当する場合)
- 関係者とユーザーに通知している (必要な場合)
移行手順
新しいカスタムドメインを追加する
ドメインの所有権を確認する
Auth0 管理の証明書を使用する場合
- Auth0 から提供された CNAME レコードを控えておきます
- DNS プロバイダーに CNAME レコードを追加します
- Auth0 Dashboard または API でドメインを検証します
自己管理の証明書を使用する場合
- DNS に必要な TXT レコードを追加します
- リバースプロキシまたは CDN を設定します
- SSL 証明書をアップロードします
- ドメインを検証します
デフォルトのドメインを設定する (任意)
アプリケーション設定を更新する
SDK の設定
必要なのは、
domain パラメーターを Auth0 の正規ドメインから新しいカスタムドメインに変更することだけです。コールバック URL
- Auth0 Dashboard > アプリケーション に移動し、設定するアプリケーションを選択して、Settings タブを開きます。
- Allowed Callback URLs に新しいドメインを追加します:
- Allowed Logout URLs を更新します:
- Allowed Web Origins を更新します:
メールテンプレートを更新する
- Branding > Custom Domains に移動します
- 使用するドメインをデフォルトに設定します
- 必要に応じて、“From” アドレス、件名、本文でカスタムドメインの情報を使うようメールテンプレートをカスタマイズします
ドメインをデフォルトに設定しても、メールの内容が自動的に変更されるわけではありません。デフォルトドメインのコンテキストがメールテンプレートで利用できるようになるだけです。その情報を使うには、テンプレートをカスタマイズする必要があります。
auth0-custom-domain ヘッダーで特定のドメインが指定されていない場合は、デフォルトドメインのコンテキストが利用可能になります。- Google Cloud Console を開きます
- APIs & Services > Credentials に移動します
- Authorized redirect URIs に
https://new-domain.example.com/login/callbackを追加します
- Facebook Developers にアクセスします
- アプリ > Facebook Login > Settings に移動します
- 有効な OAuth リダイレクト URI に
https://new-domain.example.com/login/callbackを追加します
その他のプロバイダー
エンタープライズ接続を更新する (必要に応じて)
SAML 接続
SP 起点の SAML リクエストを使用し、IdP が動的 ACS を受け入れる場合、IdP 側で ACS URL を手動で更新する必要はありません。
Azure AD 接続
- Azure Active Directory > App registrations に移動します
- アプリ > Authentication を選択します
- リダイレクト URI に
https://new-domain.example.com/login/callbackを追加します
ADFS 接続
認証をテストする
- ユーザーログイン: ユーザーが新しいドメイン経由で認証できることを確認します
- パスワードリセット: パスワードリセットメールで正しいドメインが使用されていることを確認します
- メールアドレスの確認: メールアドレス確認用のリンクが正しく機能することを確認します
- ソーシャルログイン: 設定されている各ソーシャルプロバイダーをテストします
- API 呼び出し: API 呼び出しが新しいドメインで正しく動作することを確認します
- トークンの検証: JWT に正しい
issクレームが含まれていることを確認します
監視と検証
- 認証ログを監視し、エラーがないか確認する
- メールの配信状況とリンクの動作を確認する
- SSL 証明書の有効性と有効期限を確認する
- 異なる地域からテストする (該当する場合)
- すべてのアプリケーションで、想定どおりのカスタムドメインが使用されていることを確認する
古いドメインの廃止 (該当する場合)
- すべてのアプリケーションが新しいドメインへ移行済みであることを確認します
- 古いドメインへのトラフィックを監視し、すでに使用されていないことを確認します
- 一定の猶予期間は、古いドメインを有効なまま維持することを検討します
- 準備ができたら、古いカスタムドメインを削除します:
移行パターン
並行運用(ダウンタイムなし)
並行運用(ダウンタイムなし)
古いカスタムドメインと新しいカスタムドメインを同時に運用します。
- 新しいカスタムドメインを追加する
- 新しいアプリケーションが新しいドメインを使うように更新する
- 既存のアプリケーションは古いドメインのまま維持する
- アプリケーションを段階的に移行する
- 移行完了後、古いドメインを廃止する
アプリケーションごとの段階的な移行
アプリケーションごとの段階的な移行
アプリケーションを1つずつ移行します。
- 優先度またはリスクに基づいてアプリケーションを特定する
- リスクの低いアプリケーションから先に移行する
- 問題がないか確認してから次に進む
- 残りのアプリケーションを移行する
- 古い設定を整理する
ブルーグリーンデプロイ
ブルーグリーンデプロイ
テストのために別々の環境を使用します。
- ステージング環境に新しいカスタムドメインを設定する
- すべての機能を十分にテストする
- 本番環境を1回の作業で切り替える
- 古いドメインをバックアップとして残す
- 検証期間の終了後に廃止する
既存のユーザーセッションへの対応
セッションに関する注意点
- 古いドメインで作成されたセッションは、有効期限が切れるまで引き続き有効です
- 今後のログインでは、新しいドメインでセッションが作成されます
- ドメインをまたぐセッションには、慎重な計画が必要です
推奨アプローチ
- ユーザーへの通知: 再度ログインが必要になる可能性があることをユーザーに伝える
- 猶予期間: 移行期間中も古いドメインを引き続き有効にしておく
- セッション移行: セッションの移行には Universal Login を使用する
- 明確な案内: ユーザーに問題が発生した場合に備え、わかりやすい案内を提供する
ロールバック手順
即時ロールバック
- アプリケーションの設定を以前のドメインを使用する状態に戻す
- 今後の再試行に備えて、新しいカスタムドメインの設定は維持する
- 問題を記録し、トラブルシューティングに備える
部分的なロールバック
- 影響を受けたアプリケーションを特定する
- 該当するアプリケーションのみを以前のドメインに戻す
- 問題を調査して修正する
- 準備が整ったら再移行する
完全なロールバック
- すべてのアプリケーション設定を更新し、古いドメインを使用する
- デフォルトドメインを設定している場合は、古いドメインに戻す
- 必要に応じて、ユーザーに必要な対応を通知する
- あらためて移行を試みるための予定を立てる
トラブルシューティング
よくある問題と解決策
サポートを受ける
- Auth0 Community で同様の問題が報告されていないか確認します
- トラブルシューティングに関するドキュメント を確認します
- 次の情報を添えて Auth0 Support にお問い合わせください:
- テナント名
- カスタムドメイン ID
- 問題の詳細な説明
- 再現手順
- エラーメッセージまたはログ
移行後のベストプラクティス
- 設定を文書化する: どのアプリケーションがどのカスタムドメインを使用しているかを記録します
- 証明書の有効期限を監視する: 証明書の更新に備えてアラートを設定します
- 定期的に見直す: カスタムドメインの設定がビジネスニーズに合っていることを確認します
- ランブックを更新する: 新しいカスタムドメイン情報を運用ドキュメントに反映します
- チームメンバーに周知する: 新しいマルチドメイン構成をチームが理解していることを確認します
- 拡張を見据えて計画する: 将来的に追加のドメインをどのように管理するかを検討します