> 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/org/general/add-user.md).

# Adicionar utilizador

Criar uma nova conta de utilizador no Entra ID

### Descrição

Cria um utilizador na nuvem no Entra ID com os detalhes de perfil habituais, como nome, empresa, cargo, gestor, patrocinadores e endereço. O nome de início de sessão, o alias e o nome de apresentação são derivados do nome quando deixados em branco, e uma palavra-passe inicial é gerada quando não é fornecida. Opcionalmente, o utilizador recebe um grupo de licenças, mais grupos e uma caixa de correio de arquivo do Exchange Online.

### Oferecer localizações e empresas como modelos

Os campos de endereço e a empresa são texto livre por predefinição. Com modelos de personalização do runbook, o operador escolhe uma localização do Office, o que preenche e bloqueia o bloco de endereço, e uma empresa de uma lista. O exemplo abaixo define esses modelos e associa-os aos campos do runbook:

```json
{
    "Templates": {
        "Options": [
            {
                "$id": "LocationOptions",
                "$values": [
                    {
                        "Display": "DE-OF",
                        "Customization": {
                            "Default": {
                                "StreetAddress": "Kaiserstraße 39",
                                "PostalCode": "63065",
                                "City": "Offenbach",
                                "Country": "Germany"
                            }
                        }
                    },
                    {
                        "Display": "DE-DEG",
                        "Customization": {
                            "Default": {
                                "StreetAddress": "Lateinschulgassse 24-26",
                                "PostalCode": "94469",
                                "City": "Deggendorf",
                                "Country": "Germany"
                            }
                        }
                    },
                    {
                        "Display": "DE-HH",
                        "Customization": {
                            "Default": {
                                "StreetAddress": "Hans-Henny-Jahnn-Weg 53",
                                "PostalCode": "22085",
                                "City": "Hamburg",
                                "Country": "Germany"
                            }
                        }
                    },
                    {
                        "Display": "FI-HS",
                        "Customization": {
                            "Default": {
                                "StreetAddress": "Somewhere 42",
                                "PostalCode": "12345",
                                "City": "Helsinki",
                                "Country": "Finland"
                            }
                        }
                    }
                ]
            },
            {
                "$id": "CompanyOptions",
                "$values": [
                    {
                        "Id": "gkg",
                        "Display": "glueckkanja-gab",
                        "Value": "glueckkanja-gab AG"
                    },
                    {
                        "Id": "pp",
                        "Display": "PrimePulse",
                        "Value": "PrimePulse AG"
                    }
                ]
            }
        ]
    },
    "Runbooks": {
        "rjgit-org_general_add-user": {
            "ParameterList": [
                {
                    "DisplayName": "Office Location",
                    "DisplayAfter": "CompanyName",
                    "Select": {
                        "Options": {
                            "$ref": "LocationOptions"
                        }
                    }
                },
                {
                    "Name": "CompanyName",
                    "Select": {
                        "Options": {
                            "$ref": "CompanyOptions"
                        },
                        "AllowEdit": false
                    }
                }
            ],
            "ReadOnly": [
                "StreetAddress",
                "PostalCode",
                "City",
                "Country"
            ]
        }
    }
}
```

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

Organização → Geral → Adicionar utilizador

**Nome completo do Runbook**

rjgit-org\_general\_add-user

### Detalhes

| Propriedade         | Valor                                                                             |
| ------------------- | --------------------------------------------------------------------------------- |
| Versão              | 1.0.1                                                                             |
| Módulos necessários | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>ExchangeOnlineManagement (>= 3.9.2)</p> |
| Agendável           | não                                                                               |

### Permissões

#### Permissões da aplicação

* **Tipo**: Office 365 Exchange Online
  * Exchange.ManageAsApp
    * *Abre a sessão do Exchange Online apenas da aplicação usada para grupos de distribuição e para ativar o arquivo online*

#### funções RBAC

* Administrador de utilizadores
  * *Dá suporte à criação do utilizador, à atribuição de gestor, patrocinadores e grupos e à leitura dos dados de licença*
* Administrador do Exchange
  * *Necessário para a sessão do Exchange Online apenas da aplicação que gere grupos de distribuição e o arquivo online*

### Parâmetros

#### GivenName

Nome próprio do utilizador.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | verdadeiro           |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Nome próprio         |

#### Surname

Apelido do utilizador.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | verdadeiro           |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Apelido              |

#### Nome principal do utilizador

Nome de início de sessão do utilizador. Derivado do nome quando vazio.

| Propriedade       | Valor                                                  |
| ----------------- | ------------------------------------------------------ |
| Obrigatório       | falso                                                  |
| Valor predefinido |                                                        |
| Tipo              | Cadeia de caracteres                                   |
| Oculto no portal  | sim (predefinido através da personalização do runbook) |

#### MailNickname

Alias da caixa de correio. Derivado do nome de início de sessão quando vazio.

| Propriedade       | Valor                                                  |
| ----------------- | ------------------------------------------------------ |
| Obrigatório       | falso                                                  |
| Valor predefinido |                                                        |
| Tipo              | Cadeia de caracteres                                   |
| Oculto no portal  | sim (predefinido através da personalização do runbook) |

#### DisplayName

Derivado do nome próprio e do apelido quando vazio.

| Propriedade       | Valor                                                  |
| ----------------- | ------------------------------------------------------ |
| Obrigatório       | falso                                                  |
| Valor predefinido |                                                        |
| Tipo              | Cadeia de caracteres                                   |
| Oculto no portal  | sim (predefinido através da personalização do runbook) |

#### CompanyName

Empresa a que o utilizador pertence.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Empresa              |

#### JobTitle

Apresentado no perfil e no livro de endereços.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Cargo                |

#### Departamento

Departamento em que o utilizador trabalha.

| Propriedade       | Valor                |
| ----------------- | -------------------- |
| Obrigatório       | falso                |
| Valor predefinido |                      |
| Tipo              | Cadeia de caracteres |

#### ManagerId

Utilizador que se tornará o gestor.

| Propriedade       | Valor                |
| ----------------- | -------------------- |
| Obrigatório       | falso                |
| Valor predefinido |                      |
| Tipo              | Cadeia de caracteres |

#### SponsorIds

Utilizadores registados como patrocinadores do novo utilizador. Podem ser escolhidos vários.

| Propriedade       | Valor     |
| ----------------- | --------- |
| Obrigatório       | falso     |
| Valor predefinido |           |
| Tipo              | String\[] |

#### MobilePhone

Apresentado no perfil e no livro de endereços.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Telemóvel            |

#### LocationName

Localização do Office apresentada no perfil. Com modelos da personalização do runbook, a seleção de uma também preenche os campos de endereço.

| Propriedade                | Valor                 |
| -------------------------- | --------------------- |
| Obrigatório                | falso                 |
| Valor predefinido          |                       |
| Tipo                       | Cadeia de caracteres  |
| Nome de exibição do portal | Localização do Office |

#### StreetAddress

Parte da morada postal apresentada no perfil. Preenchida pelo modelo de localização do Office quando uma é selecionada.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Morada               |

#### PostalCode

Parte da morada postal apresentada no perfil. Preenchida pelo modelo de localização do Office quando uma é selecionada.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Código postal        |

#### Cidade

Parte da morada postal apresentada no perfil. Preenchida pelo modelo de localização do Office quando uma é selecionada.

| Propriedade       | Valor                |
| ----------------- | -------------------- |
| Obrigatório       | falso                |
| Valor predefinido |                      |
| Tipo              | Cadeia de caracteres |

#### Estado

Parte da morada postal apresentada no perfil.

| Propriedade       | Valor                |
| ----------------- | -------------------- |
| Obrigatório       | falso                |
| Valor predefinido |                      |
| Tipo              | Cadeia de caracteres |

#### País

Parte da morada postal apresentada no perfil. Preenchida pelo modelo de localização do Office quando uma é selecionada.

| Propriedade       | Valor                |
| ----------------- | -------------------- |
| Obrigatório       | falso                |
| Valor predefinido |                      |
| Tipo              | Cadeia de caracteres |

#### UsageLocation

Código de país com duas letras que determina que licenças o utilizador pode obter, por exemplo DE.

| Propriedade                | Valor                     |
| -------------------------- | ------------------------- |
| Obrigatório                | falso                     |
| Valor predefinido          |                           |
| Tipo                       | Cadeia de caracteres      |
| Nome de exibição do portal | Localização de utilização |

#### DefaultLicense

Nome de apresentação do grupo que atribui a licença; o utilizador é adicionado a ele. Deixe vazio para nenhum.

| Propriedade                | Valor                       |
| -------------------------- | --------------------------- |
| Obrigatório                | falso                       |
| Valor predefinido          |                             |
| Tipo                       | Cadeia de caracteres        |
| Nome de exibição do portal | Grupo de licença a atribuir |

#### DefaultGroups

Nomes de apresentação de grupos adicionais aos quais o utilizador é adicionado, separados por vírgulas.

| Propriedade                | Valor                |
| -------------------------- | -------------------- |
| Obrigatório                | falso                |
| Valor predefinido          |                      |
| Tipo                       | Cadeia de caracteres |
| Nome de exibição do portal | Grupos a adicionar   |

#### InitialPassword

Palavra-passe inicial para o utilizador. Deixe vazio para que seja gerada uma e mostrada no resultado.

| Propriedade                | Valor                 |
| -------------------------- | --------------------- |
| Obrigatório                | falso                 |
| Valor predefinido          |                       |
| Tipo                       | Cadeia de caracteres  |
| Nome de exibição do portal | Palavra-passe inicial |

#### EnableEXOArchive

Ativa a caixa de correio de arquivo do Exchange Online para o novo utilizador.

| Propriedade                | Valor                                  |
| -------------------------- | -------------------------------------- |
| Obrigatório                | falso                                  |
| Valor predefinido          | Falso                                  |
| Tipo                       | Booleano                               |
| Nome de exibição do portal | Criar uma caixa de correio de arquivo? |

[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/org/general/add-user.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.
