Migration des identifiants utilisateur

​

Migration des identifiants utilisateur

Du point de vue de la connexion, l’identifiant principal d’un utilisateur est son adresse e-mail. Si vous passez d’une authentification locale au SSO, ou d’un IdP à un autre, vous devrez peut-être mettre à jour les adresses e-mail des utilisateurs.

Pour vous y aider, un script est fourni pour migrer les adresses e-mail des utilisateurs à partir d’un fichier CSV au format suivant :

oldEmail,newEmail

Après avoir effectué quelques vérifications, le script parcourt le fichier CSV et met à jour les adresses e-mail des utilisateurs de oldEmail vers newEmail.

​

Validation

Avant l’exécution de la migration, le <csv_file> est vérifié afin de s’assurer que :

• Pour chaque ligne, oldEmail et newEmail sont des adresses e-mail valides
• Il n’y a pas d’entrées en double, par exemple que vous ne tentez pas d’attribuer la même nouvelle adresse e-mail à plusieurs utilisateurs, ou de mettre à jour un même compte utilisateur avec une adresse e-mail déjà utilisée

​

Utilisation

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>"

​

Options

Nom	Description
--commit	L’ajout de l’option --commit effectue réellement la migration. Sans elle, la migration s’exécute en mode simulation (dry-run) : aucune modification n’est apportée, mais la validation est tout de même effectuée. Par défaut : false
--continue	L’option --continue poursuit le processus de migration si l’adresse e-mail d’un compte utilisateur a déjà été mise à jour
--ignore-missing	L’option --ignore-missing poursuit le processus de migration si un compte utilisateur est introuvable
--admin-id	--admin-id doit être défini sur l’identifiant de l’administrateur qui effectue la migration ; il sera utilisé pour les entrées du journal d’audit. Allez dans Admin > Manage Users, recherchez votre adresse e-mail et cliquez sur le premier résultat pour trouver votre identifiant utilisateur.
<csv_file>	<csv_file> est le fichier contenant les anciennes et les nouvelles adresses e-mail

​

Fin de l’exécution

Pendant l’exécution du script de migration, les options choisies déterminent si une erreur est consignée dans la console avant de poursuivre, ou consignée dans la console avant de quitter. Si le script s’arrête prématurément à cause d’une erreur, il se termine avec le code 1 pour indiquer l’échec.

À la fin de la migration, le script affiche dans la console le nombre de mises à jour réussies, en échec et ignorées. Si la migration se termine avec succès, il se termine avec le code 0.