> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Migração de nomes de usuário

## Migração de nomes de usuário

Do ponto de vista do login, o identificador principal de um usuário é o seu endereço de e-mail. Se você estiver migrando de uma autenticação local para SSO, ou de um IdP para outro, poderá ser necessário atualizar os endereços de e-mail dos usuários.

Para ajudar nisso, é fornecido um script que migra os e-mails dos usuários usando um arquivo CSV com o seguinte formato:

`oldEmail,newEmail`

Depois de realizar algumas verificações de validação, o script percorrerá o arquivo CSV e atualizará os endereços de e-mail dos usuários de `oldEmail` para `newEmail`.

### **Validação**

Antes de executar a migração, o `<csv_file>` será verificado para garantir que:

* Em cada linha, tanto o `oldEmail` quanto o `newEmail` são endereços de e-mail válidos
* Não há entradas duplicadas, por exemplo, que você não esteja tentando atualizar usuários diferentes para o mesmo novo endereço de e-mail, nem atualizar a mesma conta de usuário com um endereço de e-mail já utilizado

### **Uso**

```bash wrap theme={null}
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>"
```

### **Flags**

| Nome | Descrição |
| - | - |
| `--commit` | <p>A inclusão da flag `--commit` realiza efetivamente a migração. Quando omitida, a migração ocorre em modo de simulação (dry-run), sem fazer alterações, mas a validação continua sendo realizada.<br /><br /><strong>Padrão</strong>:`false`</p> |
| `--continue` | A flag `--continue` continua o processo de migração caso o endereço de e-mail de uma conta de usuário já tenha sido atualizado |
| `--ignore-missing` | A flag `--ignore-missing` continua o processo de migração caso uma conta de usuário não seja encontrada |
| `--admin-id` | O `--admin-id` deve ser definido como o ID do administrador que está realizando a migração e será usado nas entradas do log de auditoria. Vá até **Admin** > **Manage Users**, pesquise o seu endereço de e-mail e clique no primeiro resultado para encontrar o seu user-id. |
| `<csv_file>` | O `<csv_file>` é o arquivo que contém os endereços de e-mail antigos e novos |

### **Conclusão**

Durante a execução do script de migração, as flags escolhidas determinam se um erro é registrado no console e o processo continua, ou se é registrado no console e o processo é encerrado. Se o script terminar prematuramente devido a um erro, ele sairá com o código 1 para indicar que não foi bem-sucedido.

Ao concluir a migração, o script registrará no console o número de atualizações bem-sucedidas, com falha e ignoradas. Se a migração for concluída com sucesso, ele sairá com o código 0.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.