> 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
Remove este utilizador definitivamente: o acesso é revogado, a conta é desativada ou eliminada, as licenças e os grupos são ajustados e as associações aos 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.
### Predefinir a política de offboarding através das definições do Tenant
A maioria das opções deste runbook é suportada por definições do Tenant, pelo que uma organização pode definir a sua política de offboarding uma vez e ocultar os campos correspondentes dos operadores. O exemplo abaixo predefine todos os interruptores e oculta os campos; mantenha apenas os campos que os operadores ainda devem decidir por 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",
"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 incompatível interrompe a execução antes de qualquer alteração.
* `deleteUser`: elimina a conta (`verdadeiro`) ou mantém-na (`falso`).
* `disableUser`, `revokeAccess`: bloqueia o início de sessão e termina as sessões do utilizador.
* `exportGroupMemberships`: exporta as associações aos grupos para a conta de armazenamento do relatório (ver `RJReport.StorageAccount`) e devolve uma ligação de transferência antes de os grupos e as licenças serem alterados.
* `licensesMode`: `0` mantém as licenças atribuídas diretamente, `2` remove todas elas.
* `groupsMode`: `0` mantém os grupos, `1` remove os grupos que começam com `groupsToRemovePrefix`, `2` remove todos os grupos. Ambas as opções `1` e `2` adiciona ou mantém `groupToAdd`.
* `replaceManagerReferences`, `replaceSponsorReferences`: transfere os subordinados diretos e os patrocínios do utilizador para a pessoa substituta.
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 → Remover utilizador permanentemente
**Nome completo do Runbook**
rjgit-user\_general\_offboard-user-permanently
### Detalhes
| Propriedade | Valor |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Versão | 1.2.0 |
| Módulos necessários | RealmJoin.RunbookHelper (>= 0.8.10)
Microsoft.Graph.Authentication (>= 2.41.2)
Az.Accounts (>= 5.5.2)
ExchangeOnlineManagement (>= 3.9.2)
|
| Agendável | não |
### Permissões
#### Permissões da aplicação
* **Tipo**: Microsoft Graph
* User.ReadWrite.All
* *Desativa o início de sessão, revoga as sessões, remove licenças, substitui as referências ao gestor e ao patrocinador e elimina o objeto de utilizador*
* Group.ReadWrite.All
* *Lê os grupos e transfere ou remove as titularidades de grupos do utilizador*
* GroupMember.ReadWrite.All
* *Adiciona e remove associações a 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 conta de armazenamento de destino - o carregamento obtém as chaves da conta através de listKeys (apenas necessário quando exportGroupMemberships é usado)
#### funções RBAC
* Administrador de utilizadores
* *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 da aplicação que remove as associações a grupos de distribuição*
### Parâmetros
#### Nome de utilizador
Nome principal do utilizador sobre o qual o runbook atua. Definido pelo portal a partir do utilizador selecionado.
| Propriedade | Valor |
| ----------------- | ------------------------------------------------------ |
| Obrigatório | verdadeiro |
| Valor predefinido | |
| Tipo | Cadeia de caracteres |
| Oculto no portal | sim (predefinido através da personalização do runbook) |
#### UserTypeSelector
Executa apenas para o tipo de utilizador escolhido: todos os utilizadores, apenas membros ou apenas convidados. Em caso de incompatibilidade, a execução é interrompida antes de qualquer alteração.
| Propriedade | Valor |
| -------------------------- | ---------------------------------- |
| Obrigatório | falso |
| Valor predefinido | 0 |
| Tipo | Int32 |
| Nome de exibição do 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
Delete remove o objeto de utilizador. Manter deixa a conta no lugar; o que lhe acontece segue as outras opções.
| Propriedade | Valor |
| -------------------------- | -------------------------- |
| Obrigatório | falso |
| Valor predefinido | Falso |
| Tipo | Booleano |
| Nome de exibição do 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 para impedir o início de sessão.
| Propriedade | Valor |
| ----------------- | ---------- |
| Obrigatório | falso |
| Valor predefinido | 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 predefinido | Verdadeiro |
| Tipo | Booleano |
#### exportGroupMemberships
Exporta as associações aos grupos do utilizador para um ficheiro e devolve uma ligação de transferência antes de os grupos e as licenças serem alterados. Retirado da definição do Tenant OffboardUserPermanently.exportGroupMemberships.
| Propriedade | Valor |
| ----------------- | ------------------------------------------------------ |
| Obrigatório | falso |
| Valor predefinido | Falso |
| Tipo | Booleano |
| Oculto no portal | sim (predefinido através 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 predefinido | user-leaver-groupmemberships |
| Tipo | Cadeia de caracteres |
| Oculto no portal | sim (predefinido através da personalização do runbook) |
#### ResourceGroupName
Grupo de recursos da conta de armazenamento para carregamentos do relatório. Obtido a partir da definição de tenant RJReport.StorageAccount.ResourceGroup.
| Propriedade | Valor |
| ----------------- | ------------------------------------------------------ |
| Obrigatório | falso |
| Valor predefinido | |
| Tipo | Cadeia de caracteres |
| Oculto no portal | sim (predefinido através da personalização do runbook) |
#### StorageAccountName
Conta de armazenamento para carregamentos do relatório. Obtida a partir da definição de tenant RJReport.StorageAccount.StorageAccountName.
| Propriedade | Valor |
| ----------------- | ------------------------------------------------------ |
| Obrigatório | falso |
| Valor predefinido | |
| Tipo | Cadeia de caracteres |
| Oculto no portal | sim (predefinido através da personalização do runbook) |
#### LinkExpiryDays
Número de dias que uma ligação de download permanece válida. Obtido a partir da definição de tenant RJReport.StorageAccount.LinkExpiryDays.
| Propriedade | Valor |
| ----------------- | ------------------------------------------------------ |
| Obrigatório | falso |
| Valor predefinido | 6 |
| Tipo | Int32 |
| Oculto no portal | sim (predefinido através da personalização do runbook) |
#### ChangeLicensesSelector
Remover tudo retira todas as licenças atribuídas diretamente; as licenças herdadas dos grupos permanecem.
| Propriedade | Valor |
| -------------------------- | ------------------------------- |
| Obrigatório | falso |
| Valor predefinido | 0 |
| Tipo | Int32 |
| Nome de exibição do 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. Ambas as opções adicionam ou mantêm o grupo em "Grupo a adicionar ou manter". Os grupos dinâmicos, atribuíveis por função e no local são ignorados e listados.
| Propriedade | Valor |
| -------------------------- | -------------------- |
| Obrigatório | falso |
| Valor predefinido | 0 |
| Tipo | Int32 |
| Nome de exibição do portal | Associações a 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 precisa 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 predefinido | |
| Tipo | Cadeia de caracteres |
#### GroupsToRemovePrefix
Os grupos cujo nome começa com este texto são removidos, por exemplo LIC\_ para todos os grupos de licenças. Apenas usado com "Remover grupos com o prefixo".
| Propriedade | Valor |
| ----------------- | -------------------- |
| Obrigatório | falso |
| Valor predefinido | |
| Tipo | Cadeia de caracteres |
#### RevokeGroupOwnership
Remover ou substituir retira as titularidades de grupos do utilizador. Quando este utilizador é o último proprietário, o substituto assume; sem substituto, o grupo é listado para seguimento manual. Manter deixa as titularidades como estão.
| Propriedade | Valor |
| -------------------------- | ----------------------- |
| Obrigatório | falso |
| Valor predefinido | Verdadeiro |
| Tipo | Booleano |
| Nome de exibição do portal | Titularidades de grupos |
**Opções do portal**
| Opção do portal | Valor |
| ---------------------------------------------------- | ---------- |
| Manter as titularidades do utilizador | falso |
| Remover ou substituir as titularidades do utilizador | verdadeiro |
#### ManagerAsReplacementOwner
Usa o gestor do utilizador no Entra ID como proprietário substituto, gestor e patrocinador. Se houver um gestor definido, esse é usado em vez da "Pessoa substituta".
| Propriedade | Valor |
| -------------------------- | ------------------------------ |
| Obrigatório | falso |
| Valor predefinido | Verdadeiro |
| Tipo | Booleano |
| Nome de exibição do 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 um.
| Propriedade | Valor |
| ----------------- | -------------------- |
| Obrigatório | falso |
| Valor predefinido | |
| Tipo | Cadeia de caracteres |
#### 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 predefinido | Falso |
| Tipo | Booleano |
| Nome de exibição do 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 sempre que 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 predefinido | Falso |
| Tipo | Booleano |
| Nome de exibição do 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](/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=&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.