> 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/invite-external-guest-users.md).

# Convidar utilizadores convidados externos

Convidar uma pessoa externa como utilizador convidado

### Descrição

Envia um convite de convidado do Microsoft Entra ID para um endereço de e-mail externo. Opcionalmente, o convidado é adicionado a um grupo, e detalhes do perfil como nome, empresa, local de utilização, gestor e patrocinador são definidos imediatamente na conta do convidado. O e-mail de convite e a página de destino podem ser personalizados.

### Casos de uso comuns

* Convite básico para convidado: forneça apenas o endereço de e-mail e o nome a apresentar; todos os parâmetros de perfil e grupo podem ser deixados em branco.
* Integração completa: forneça todos os campos opcionais para definir propriedades do perfil, atribuir um gestor e um patrocinador e adicionar o convidado a um grupo numa única execução.

### Interações entre parâmetros

* Propriedades do perfil (`primeiro nome`, `apelido`, `nome da empresa`, `local de utilização`) são aplicadas apenas quando não estão vazias; omiti-las ignora completamente a chamada de atualização.
* A atribuição de gestor, a atribuição de patrocinador e a associação a grupo requerem cada uma os respetivos parâmetros; todas são ignoradas silenciosamente quando não são fornecidas.

### Localização

Organização → Geral → Convidar utilizadores convidados externos

**Nome completo do Runbook**

rjgit-org\_general\_Invite-external-guest-users

### Detalhes

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

### Permissões

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

* **Tipo**: Microsoft Graph
  * User.ReadWrite.All
    * *Cria o convite, atualiza as propriedades do perfil do convidado e define o gestor e o patrocinador*
  * Group.ReadWrite.All
    * *Verifica o grupo de destino e adiciona o convidado através de /groups/{id}/members/$ref*
  * Organization.Read.All
    * *Lê o ID do Tenant para construir o URL de redirecionamento de convite predefinido*

### Parâmetros

#### InvitedUserEmail

Endereço de e-mail da pessoa a convidar.

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

#### InvitedUserDisplayName

Nome apresentado para o convidado no diretório.

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

#### GroupId

Grupo ao qual o convidado é adicionado. Predefinido na personalização do runbook; vazio significa nenhum.

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

#### GivenName

Primeiro nome do convidado.

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

#### Surname

Apelido do convidado.

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

#### CompanyName

Empresa para a qual o convidado trabalha.

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

#### ManagerName

Utilizador que se torna o gestor do convidado.

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

#### SponsorName

Utilizador registado como patrocinador do convidado.

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

#### CustomizeInvitation

Mostra campos para uma mensagem de convite personalizada e URL de redirecionamento.

| Propriedade       | Valor    |
| ----------------- | -------- |
| Obrigatório       | falso    |
| Valor predefinido | Falso    |
| Tipo              | Booleano |

#### InvitationMessage

Texto incluído no e-mail de convite.

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

#### InviteRedirectUrl

Página para onde o convidado é encaminhado depois de aceitar, por exemplo um site do SharePoint.

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

#### UsageLocation

Código de país de duas letras, por exemplo US ou DE, necessário antes de poderem ser atribuídas licenças.

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

[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/invite-external-guest-users.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.