> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/pt/gestao-de-utilizadores-e-projetos/user-management.md).

# Gestão de utilizadores

## Criar um utilizador administrador

Implementações do Overleaf Toolkit:

{% code title="Overleaf Toolkit" overflow="wrap" %}

```bash
$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"
```

{% endcode %}

Implementações legacy do docker-compose.yml:

{% code title="Docker-compose legacy" overflow="wrap" %}

```bash
$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/create-user --admin --email=joe@example.com"
```

{% endcode %}

O comando criará um utilizador com o endereço de email fornecido, se ainda não existir, e torná-lo-á administrador. A saída do comando inclui um URL para visitar onde pode definir a palavra-passe para este utilizador e iniciar sessão pela primeira vez.

{% hint style="info" %}
Para uma abordagem programática, pode usar o mesmo script para criar utilizadores normais, bem como administradores. Para utilizadores normais, omita a flag --admin.
{% endhint %}

Se utilizar contas internas para autenticação e precisar de promover um utilizador existente a administrador da instância ou revogar permissões de administrador, faça o seguinte:

{% stepper %}
{% step %}

### Através da IU de administração

* Inicie sessão como um administrador existente.
* Clique em Admin -> Gerir utilizadores.
* Procure o utilizador e clique no respetivo endereço de email.
* Desloque-se até à secção Administrador do site e clique na ligação (mostrar).
* Marque a caixa É Administrador do site.
* Clique em Guardar para terminar.
  {% endstep %}
  {% endstepper %}

***

## Eliminar utilizadores

Como explicado no nosso guia sobre [compreender a utilização da licença](broken://pages/a9b3c4be2303640e606f2b3a52a992800455d0f6), geralmente é aconselhável não eliminar contas, a menos que já não sejam necessárias. Eliminar uma conta remove a conta e faz com que os colaboradores percam o acesso aos projetos. Atualmente, não há forma de desativar contas — elas ou existem com os respetivos dados preservados ou são eliminadas.

Por predefinição, as contas são eliminadas de forma reversível. Para obter informações sobre como remover permanentemente utilizadores da sua instância, consulte o `ENABLE_CRON_RESOURCE_DELETION` no [Variáveis de ambiente](broken://pages/bebd79526d51f42f281ec14e1abe014d835a8048) guia.

{% hint style="info" %}
As contas são eliminadas de forma reversível por predefinição. Consulte `ENABLE_CRON_RESOURCE_DELETION` para o comportamento de eliminação permanente.
{% endhint %}

### Através de Admin -> Gerir utilizadores

{% stepper %}
{% step %}

* Inicie sessão como administrador.
* Clique em Admin -> Gerir utilizadores.
* Procure o utilizador e marque a caixa ao lado do respetivo endereço de email.
* Clique no ícone do caixote do lixo.
* Clique em Eliminar para confirmar.
  {% endstep %}
  {% endstepper %}

### Através da linha de comandos

As contas de utilizador (e os respetivos projetos) podem ser eliminadas usando os seguintes comandos.

Implementações do Overleaf Toolkit:

{% code title="Overleaf Toolkit" %}

```bash
$ bin/docker-compose exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"
```

{% endcode %}

Implementações legacy do docker-compose.yml:

{% code title="Docker-compose legacy" %}

```bash
$ docker exec sharelatex /bin/bash -ce "cd /overleaf/services/web && node modules/server-ce-scripts/scripts/delete-user.mjs --email=joe@example.com"
```

{% endcode %}

{% hint style="danger" %}
O script de eliminação usa uma opção de força codificada que garante que a eliminação prossiga mesmo que o email de eliminação da conta não seja enviado (por exemplo, quando o email do utilizador já não está em funcionamento).
{% endhint %}

{% hint style="info" %}
Desde a versão 5.5.0, a opção --skip-email pode ser usada para impedir o envio de um email informativo ao utilizador eliminado.
{% endhint %}

***

## Restaurar um utilizador eliminado de forma reversível

Se um utilizador tiver sido apenas eliminado de forma reversível, pode restaurar a respetiva conta e projetos.

{% stepper %}
{% step %}

* Inicie sessão como administrador.
* Clique em Admin -> Gerir utilizadores.
* Procure o utilizador que pretende restaurar.
* Clique no botão Mostrar utilizadores eliminados.
* Clique no endereço de email do utilizador eliminado.
* Clique em Recuperar esta conta.
* Clique em Recuperar para confirmar.
  {% endstep %}
  {% endstepper %}

{% hint style="danger" %}
Quando ENABLE\_CRON\_RESOURCE\_DELETION está definido como true, as contas eliminadas de forma reversível podem ser restauradas dentro de uma janela de 90 dias. Após 90 dias, a recuperação da conta não é possível.
{% endhint %}

***

## Contar utilizadores

Pode obter contagens de utilizadores através da IU de administração em <https://you-instance-url/admin/user#license>. Para verificações e exportações programáticas, os seguintes exemplos podem ser úteis.

Número total de utilizadores:

{% code title="Número total de utilizadores" %}

```bash
echo 'db.users.countDocuments()' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 16
```

{% endcode %}

Número total de utilizadores usando o endpoint de métricas:

{% code title="N.º de utilizadores ativos a partir das métricas" %}

```bash
docker exec sharelatex curl http://127.0.0.1:3000/metrics | grep num_active_users
# # HELP num_active_users num_active_users
# # TYPE num_active_users gauge
# num_active_users{app="web-api",host="b3ae4ff549d8"} 16
```

{% endcode %}

Número total de utilizadores ativos (exemplo: utilizadores ativos nos últimos 365 dias):

{% code title="Número total de utilizadores ativos" %}

```bash
echo 'db.users.countDocuments({ lastActive: { $gte: new Date(new Date().getTime() - (365 * 24 * 60 * 60 * 1000)) } })' | docker exec -i mongo mongosh --quiet localhost/sharelatex
# overleaf [direct: primary] sharelatex> 10
```

{% endcode %}

***

## Atualizar informações da conta de utilizador

A forma como as atualizações da conta são efetuadas depende de o SSO estar ativado ou não.

* Se o SSO não for utilizado:
  * Os administradores podem modificar as informações da conta do utilizador através de Admin -> Gerir utilizadores (email, nome próprio, apelido e gerar uma ligação de reposição da palavra-passe).
  * Os utilizadores normais podem atualizar os seus próprios detalhes através de Conta -> Definições da conta (incluindo alterar a palavra-passe e gerar tokens de autenticação Git).
* Se o SSO for utilizado:
  * O Server Pro pode ser configurado para atualizar o nome próprio e o apelido de um utilizador durante o início de sessão, com base no sistema de autenticação.
  * Quando OVERLEAF\_SAML\_UPDATE\_USER\_DETAILS\_ON\_LOGIN ou OVERLEAF\_LDAP\_UPDATE\_USER\_DETAILS\_ON\_LOGIN estão definidos como true, o formulário de detalhes do utilizador em <https://your-instance-url/user/settings> é desativado e o nome próprio/apelido só pode ser definido no seu sistema de gestão de identidades.

Para mais detalhes, consulte:

* Configuração SAML 2.0: <https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/saml-2.0>
* Configuração LDAP: <https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/ldap>

***

Última atualização há 4 meses

Esta página de documentação contém ligações para guias e páginas de configuração externas. Todas as ligações e parâmetros de consulta são preservados tal como no conteúdo original.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ayakaleaf-pro.ayaka.space/on-premises/pt/gestao-de-utilizadores-e-projetos/user-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
