> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references/user/general/offboard-user-permanently.md).

# Desativar utilizador permanentemente

Desativar permanentemente este utilizador

### Descrição

Desativa este utilizador de forma permanente: o acesso é revogado, a conta é desativada ou eliminada, as licenças e os grupos são ajustados, e as pertenças a grupos podem ser exportadas antes de serem alteradas. As titularidades de grupos, os subordinados diretos e os patrocínios de convidados podem ser transferidos para um substituto. Uma conta eliminada só pode ser restaurada durante 30 dias.

### Defina previamente a política de offboarding através das configurações do Tenant

A maioria dos comutadores deste runbook é suportada por configurações do Tenant, pelo que uma organização pode definir a política de offboarding uma vez e ocultar os campos correspondentes dos operadores. O exemplo abaixo predefine todos os comutadores e oculta os campos; mantenha apenas os campos que os operadores ainda devem decidir em cada execução.

```json
{
    "Settings": {
        "OffboardUserPermanently": {
            "userTypeRestriction": 0,
            "deleteUser": true,
            "disableUser": true,
            "revokeAccess": true,
            "exportGroupMemberships": true,
            "licensesMode": 0,
            "groupsMode": 0,
            "groupToAdd": "",
            "groupsToRemovePrefix": "",
            "replaceManagerReferences": true,
            "replaceSponsorReferences": true
        },
        "RJReport": {
            "StorageAccount": {
                "ResourceGroup": "rj-test-runbooks-01",
                "StorageAccountName": "rjrbexports01",
                "SubscriptionId": "00000000-0000-0000-0000-000000000000",
                "LinkExpiryDays": 6
            }
        }
    },
    "Runbooks": {
        "rjgit-user_general_offboard-user-permanently": {
            "ParameterList": [
                { "Name": "UserTypeSelector", "Hide": true },
                { "Name": "DisableUser", "Hide": true },
                { "Name": "RevokeAccess", "Hide": true },
                { "Name": "ChangeLicensesSelector", "Hide": true },
                { "Name": "ChangeGroupsSelector", "Hide": true },
                { "Name": "GroupToAdd", "Hide": true },
                { "Name": "GroupsToRemovePrefix", "Hide": true },
                { "Name": "CallerName", "Hide": true }
            ]
        }
    }
}
```

Significado das definições:

* `userTypeRestriction`: `0` permite todos os tipos de utilizador, `1` apenas membros, `2` apenas convidados. Um utilizador que não corresponda interrompe a execução antes de qualquer alteração.
* `deleteUser`: eliminar a conta (`verdadeiro`) ou mantê-la (`falso`).
* `disableUser`, `revokeAccess`: bloquear o início de sessão e terminar as sessões do utilizador.
* `exportGroupMemberships`: exportar as filiações em grupos para a Storage Account de relatório (ver `RJReport.StorageAccount`) e devolver uma ligação de transferência antes de grupos e licenças serem alterados.
* `licensesMode`: `0` mantém as licenças atribuídas diretamente, `2` remove todas.
* `groupsMode`: `0` mantém os grupos, `1` remove os grupos que começam com `groupsToRemovePrefix`, `2` remove todos os grupos. Ambos `1` e `2` adicionar ou manter `groupToAdd`.
* `replaceManagerReferences`, `replaceSponsorReferences`: transferir os subordinados diretos e patrocínios do utilizador para a pessoa de substituição.

Para mais informações sobre como personalizar runbooks, consulte o [Guia de Personalização de Runbooks](https://docs.realmjoin.com/automation/runbooks/runbook-customization).

### Localização

Utilizador → Geral → Desativar utilizador permanentemente

**Nome completo do runbook**

rjgit-user\_general\_offboard-user-permanently

### Detalhes

| Propriedade         | Valor                                                                                                                                                     |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Versão              | 1.3.0                                                                                                                                                     |
| Módulos necessários | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>Microsoft.Graph.Authentication (>= 2.41.2)<br>Az.Accounts (>= 5.5.2)<br>ExchangeOnlineManagement (>= 3.9.2)</p> |
| Agendável           | não                                                                                                                                                       |

### Permissões

#### Permissões de aplicativo

* **Tipo**: Microsoft Graph
  * User.ReadWrite.All
    * *Desativa o início de sessão, revoga as sessões, remove licenças, substitui referências ao gestor e ao patrocinador e elimina o objeto do utilizador*
  * Group.ReadWrite.All
    * *Lê os grupos e transfere ou remove as titularidades de grupo do utilizador*
  * GroupMember.ReadWrite.All
    * *Adiciona e remove filiações em grupos durante a limpeza de grupos*
* **Tipo**Office 365 Exchange Online
  * Exchange.ManageAsApp
    * *Abre a sessão do Exchange Online apenas para aplicação usada para remover o utilizador dos grupos de distribuição*

#### Notas de permissão

Azure Storage Account: função 'Reader and Data Access' para a identidade gerida da Automation Account na Storage Account de destino - o upload obtém as chaves da conta através de listKeys (apenas necessário quando exportGroupMemberships é usado)

#### Funções RBAC

* Administrador de Usuários
  * *Necessário para que a identidade apenas da aplicação possa bloquear o início de sessão, revogar sessões e eliminar o utilizador*
* Administrador do Exchange
  * *Necessário para a sessão do Exchange Online apenas para aplicação que remove filiações em grupos de distribuição*

### Parâmetros

#### Nome de usuário

Nome principal do usuário no qual o runbook atua. Definido pelo portal a partir do usuário selecionado.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | verdadeiro                                              |
| Valor padrão     |                                                         |
| Tipo             | Texto                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### UserTypeSelector

Só é executado para o tipo de utilizador escolhido: todos os utilizadores, apenas membros ou apenas convidados. Em caso de divergência, a execução é interrompida antes de qualquer alteração.

| Propriedade                | Valor                              |
| -------------------------- | ---------------------------------- |
| Obrigatório                | falso                              |
| Valor padrão               | 0                                  |
| Tipo                       | Int32                              |
| Nome de exibição no portal | Restringir a um tipo de utilizador |

**Opções do portal**

| Opção do portal                                              | Valor |
| ------------------------------------------------------------ | ----- |
| Permitir todos os tipos de utilizador (Membros e Convidados) | 0     |
| Apenas membros                                               | 1     |
| Apenas convidados                                            | 2     |

#### DeleteUser

Eliminar remove o objeto do utilizador. Manter deixa a conta no lugar; o que lhe acontece depende das outras opções.

| Propriedade                | Valor                      |
| -------------------------- | -------------------------- |
| Obrigatório                | falso                      |
| Valor padrão               | Falso                      |
| Tipo                       | Booleano                   |
| Nome de exibição no portal | Eliminar ou manter a conta |

**Opções do portal**

| Opção do portal  | Valor      |
| ---------------- | ---------- |
| Eliminar a conta | verdadeiro |
| Manter a conta   | falso      |

#### Desativar utilizador

Bloqueia a conta de iniciar sessão.

| Propriedade  | Valor      |
| ------------ | ---------- |
| Obrigatório  | falso      |
| Valor padrão | Verdadeiro |
| Tipo         | Booleano   |

#### RevokeAccess

Termina as sessões ativas do utilizador e invalida os respetivos tokens de atualização.

| Propriedade  | Valor      |
| ------------ | ---------- |
| Obrigatório  | falso      |
| Valor padrão | Verdadeiro |
| Tipo         | Booleano   |

#### exportGroupMemberships

Exporta as pertenças do utilizador a grupos para um ficheiro e devolve uma ligação de download antes de os grupos e as licenças serem alterados. Obtido a partir da definição do Tenant OffboardUserPermanently.exportGroupMemberships.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     | Falso                                                   |
| Tipo             | Booleano                                                |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### ContainerName

Contentor de armazenamento para o qual é carregada a exportação. Definido por runbook.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     | user-leaver-groupmemberships                            |
| Tipo             | Texto                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### ResourceGroupName

Grupo de recursos da Storage Account para uploads de relatórios. Obtido da configuração do Tenant RJReport.StorageAccount.ResourceGroup.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     |                                                         |
| Tipo             | Texto                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### StorageAccountName

Storage Account para uploads de relatórios. Obtida da configuração do Tenant RJReport.StorageAccount.StorageAccountName.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     |                                                         |
| Tipo             | Texto                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### SubscriptionId

ID da assinatura da Storage Account para uploads de relatórios. Obtido da configuração do Tenant RJReport.StorageAccount.SubscriptionId; quando vazio, é usada a assinatura na qual a identidade gerenciada entra.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     |                                                         |
| Tipo             | Texto                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### LinkExpiryDays

Número de dias que um link de download permanece válido. Obtido da configuração do Tenant RJReport.StorageAccount.LinkExpiryDays.

| Propriedade      | Valor                                                   |
| ---------------- | ------------------------------------------------------- |
| Obrigatório      | falso                                                   |
| Valor padrão     | 6                                                       |
| Tipo             | Int32                                                   |
| Oculto no portal | sim (predefinido por meio da personalização do runbook) |

#### ChangeLicensesSelector

Remover tudo retira todas as licenças atribuídas diretamente; as licenças herdadas de grupos mantêm-se.

| Propriedade                | Valor                           |
| -------------------------- | ------------------------------- |
| Obrigatório                | falso                           |
| Valor padrão               | 0                               |
| Tipo                       | Int32                           |
| Nome de exibição no portal | Licenças atribuídas diretamente |

**Opções do portal**

| Opção do portal                                  | Valor |
| ------------------------------------------------ | ----- |
| Não alterar as licenças atribuídas               | 0     |
| Remover todas as licenças atribuídas diretamente | 2     |

#### ChangeGroupsSelector

Remover grupos com o prefixo remove os grupos nomeados pelo prefixo; Remover todos os grupos remove todos os grupos. Ambos adicionam ou mantêm o grupo em "Grupo a adicionar ou manter". Os grupos dinâmicos, atribuíveis por função e locais são ignorados e listados.

| Propriedade                | Valor               |
| -------------------------- | ------------------- |
| Obrigatório                | falso               |
| Valor padrão               | 0                   |
| Tipo                       | Int32               |
| Nome de exibição no portal | Filiações em grupos |

**Opções do portal**

| Opção do portal                  | Valor |
| -------------------------------- | ----- |
| Não alterar os grupos atribuídos | 0     |
| Remover grupos com o prefixo     | 1     |
| Remover todos os grupos          | 2     |

#### GroupToAdd

Grupo de que o utilizador ainda necessita após o offboarding, por exemplo um grupo de licenças de saída. É adicionado se estiver em falta e nunca é removido.

| Propriedade  | Valor |
| ------------ | ----- |
| Obrigatório  | falso |
| Valor padrão |       |
| Tipo         | Texto |

#### GroupsToRemovePrefix

Os grupos cujo nome começa com este texto são removidos, por exemplo LIC\_ para todos os grupos de licenças. Utilizado apenas com "Remover grupos com o prefixo".

| Propriedade  | Valor |
| ------------ | ----- |
| Obrigatório  | falso |
| Valor padrão |       |
| Tipo         | Texto |

#### RevokeGroupOwnership

Remover ou substituir retira ao utilizador as titularidades de grupo. Onde este utilizador é o último proprietário, o substituto assume; sem substituto, o grupo é listado para acompanhamento manual. Manter deixa as titularidades como estão.

| Propriedade                | Valor                  |
| -------------------------- | ---------------------- |
| Obrigatório                | falso                  |
| Valor padrão               | Verdadeiro             |
| Tipo                       | Booleano               |
| Nome de exibição no portal | Titularidades de grupo |

**Opções do portal**

| Opção do portal                                      | Valor      |
| ---------------------------------------------------- | ---------- |
| Manter as titularidades do utilizador                | falso      |
| Remover ou substituir as titularidades do utilizador | verdadeiro |

#### ManagerAsReplacementOwner

Utiliza o gestor do utilizador do Entra ID como proprietário, gestor e patrocinador de substituição. Se estiver definido um gestor, este é usado em vez da "Pessoa de substituição".

| Propriedade                | Valor                          |
| -------------------------- | ------------------------------ |
| Obrigatório                | falso                          |
| Valor padrão               | Verdadeiro                     |
| Tipo                       | Booleano                       |
| Nome de exibição no portal | Usar o gestor como substituto? |

#### ReplacementOwnerName

Pessoa que assume as titularidades, os subordinados diretos e os patrocínios quando o gestor não é usado ou este utilizador não tem nenhum.

| Propriedade  | Valor |
| ------------ | ----- |
| Obrigatório  | falso |
| Valor padrão |       |
| Tipo         | Texto |

#### ReplaceManagerReferences

Define o substituto como gestor de todos os que reportam a este utilizador. Sem substituto, esses utilizadores são apenas listados.

| Propriedade                | Valor                           |
| -------------------------- | ------------------------------- |
| Obrigatório                | falso                           |
| Valor padrão               | Falso                           |
| Tipo                       | Booleano                        |
| Nome de exibição no portal | Gestor dos subordinados diretos |

**Opções do portal**

| Opção do portal                                                  | Valor      |
| ---------------------------------------------------------------- | ---------- |
| Manter este utilizador como gestor dos seus subordinados diretos | falso      |
| Definir o substituto como gestor dos subordinados diretos        | verdadeiro |

#### ReplaceSponsorReferences

Substitui este utilizador como patrocinador em todos os locais onde esteja definido como tal, normalmente em utilizadores convidados. Sem substituto, esses utilizadores são apenas listados. Os patrocínios mantidos através de um grupo permanecem. Isto analisa todos os utilizadores do Tenant.

| Propriedade                | Valor                      |
| -------------------------- | -------------------------- |
| Obrigatório                | falso                      |
| Valor padrão               | Falso                      |
| Tipo                       | Booleano                   |
| Nome de exibição no portal | Patrocinador de convidados |

**Opções do portal**

| Opção do portal                                                           | Valor      |
| ------------------------------------------------------------------------- | ---------- |
| Manter este utilizador como patrocinador                                  | falso      |
| Substituir este utilizador como patrocinador de utilizadores (convidados) | verdadeiro |

[Voltar à visão geral da referência do runbook](https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references.md)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/pt/automatizacao/runbooks/runbook-references/user/general/offboard-user-permanently.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
