ユーザー名の移行

​

ユーザー名の移行

ログインの観点では、ユーザーの主な識別子はメールアドレスです。ローカルベースの認証から SSO に移行する場合や、ある IdP から別の IdP に移行する場合、ユーザーのメールアドレスを更新する必要が生じることがあります。

これを支援するために、次の形式の CSV ファイルを使用してユーザーのメールアドレスを移行するスクリプトが用意されています：

oldEmail,newEmail

いくつかの検証チェックを行った後、スクリプトは CSV ファイルを順に処理し、ユーザーのメールアドレスを oldEmail から newEmail に更新します。

​

検証

移行を実行する前に、<csv_file> が次の条件を満たしているかチェックされます：

• 各行について、oldEmail と newEmail の両方が有効なメールアドレスであること
• 重複したエントリがないこと。たとえば、異なるユーザーを同じ新しいメールアドレスに更新しようとしていないこと、または同じユーザーアカウントを既に使用されているメールアドレスに更新しようとしていないこと

​

使い方

docker cp <csv_file> sharelatex:/overleaf/services/web/<csv_file> docker exec sharelatex /bin/bash -c "cd /overleaf/services/web;node ./modules/server-ce-scripts/scripts/migrate-user-emails.js [--commit] [--continue|--ignore-missing] [--admin-id=ADMIN_USER_ID] <csv_file>"

​

フラグ

名前	説明
--commit	--commit フラグを指定すると、実際に移行が実行されます。省略した場合、移行はドライランモードで実行され、変更は行われませんが検証は実行されます。 デフォルト：false
--continue	--continue フラグを指定すると、ユーザーアカウントのメールアドレスが既に更新されている場合でも移行処理を続行します
--ignore-missing	--ignore-missing フラグを指定すると、ユーザーアカウントが見つからなかった場合でも移行処理を続行します
--admin-id	--admin-id には移行を実行する管理者の ID を設定します。この ID は監査ログのエントリに使用されます。自分のユーザー ID を確認するには、Admin > Manage Users に移動して自分のメールアドレスを検索し、最初の結果をクリックしてください。
<csv_file>	<csv_file> は、旧メールアドレスと新メールアドレスが記載されたファイルです

​

完了

移行スクリプトの実行中、選択したフラグによって、エラーをコンソールに記録して処理を続行するか、コンソールに記録して終了するかが決まります。エラーによりスクリプトが途中で終了した場合は、失敗したことを示すために終了コード 1 で終了します。

移行が完了すると、スクリプトは成功、失敗、スキップされた更新の件数をコンソールに出力します。移行が正常に完了した場合は、終了コード 0 で終了します。