> 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/automacao/runbooks/runbook-references/org/general/invite-external-guest-users.md).
# Convidar utilizadores convidados externos
### Descrição
Este runbook convida um utilizador externo como utilizador convidado no Microsoft Entra ID. Propriedades opcionais do perfil, como nome próprio, apelido, nome da empresa, localização de utilização, gestor e patrocinador, podem ser definidas após a aceitação do convite. O utilizador convidado pode, opcionalmente, ser adicionado a um grupo especificado.
### Localização
Organização → Geral → Convidar Utilizadores Convidados Externos
**Nome completo do runbook**
rjgit-org\_general\_Convidar-utilizadores-convidados-externos
### Detalhes
| Propriedade | Valor |
| ------------------- | --------------------------------------------------------------------------------------- |
| Versão | 2.0.3 |
| Módulos necessários | RealmJoin.RunbookHelper (>= 0.8.9)
Microsoft.Graph.Authentication (>= 2.39.0)
|
| Agendável | não |
### Notas
Casos de uso comuns:
* Convite básico de convidado: forneça apenas o endereço de e-mail e o nome de exibição; todos os parâmetros do perfil e do grupo podem ser deixados em branco
* Integração completa: forneça todos os campos opcionais para definir propriedades do perfil, atribuir um gestor/patrocinador e adicionar a um grupo numa única execução
Interações de parâmetros:
* As propriedades do perfil (givenName, surname, companyName, usageLocation) são aplicadas apenas quando não estão vazias; omiti-las ignora totalmente a chamada PATCH
* A atribuição de gestor e patrocinador e a pertença a grupos exigem os respetivos parâmetros; tudo é ignorado silenciosamente quando não é fornecido
### Permissões
#### Permissões de aplicação
* **Tipo**: Microsoft Graph
* User.ReadWrite.All
* *Cria o convite, atualiza as propriedades do perfil do convidado e define gestor e 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 predefinido do convite*
### Parâmetros
#### Email do utilizador convidado
Endereço de e-mail do utilizador convidado a convidar.
| Propriedade | Valor |
| ------------ | ---------- |
| Obrigatório | verdadeiro |
| Valor padrão | |
| Tipo | String |
#### Nome de exibição do utilizador convidado
Nome de exibição do utilizador convidado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### ID do grupo
O ID do objeto do grupo ao qual adicionar o utilizador convidado. Se não for especificado, o utilizador não será adicionado a nenhum grupo.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### GivenName
Nome próprio (primeiro nome) do utilizador convidado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### Surname
Apelido (último nome) do utilizador convidado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### CompanyName
Nome da empresa do utilizador convidado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### Nome do gestor
Gestor a atribuir ao utilizador convidado. Selecione um utilizador do diretório.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### Nome do patrocinador
Patrocinador a atribuir ao utilizador convidado. Selecione um utilizador do diretório.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### Personalizar convite
Ative para personalizar a mensagem do convite e o URL de redirecionamento.
| Propriedade | Valor |
| ------------ | -------- |
| Obrigatório | falso |
| Valor padrão | Falso |
| Tipo | Booleano |
#### Mensagem do convite
Corpo da mensagem personalizada a incluir no e-mail do convite. Utilizado apenas quando Personalizar convite está ativado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### URL de redirecionamento do convite
URL personalizado para o qual o utilizador é redirecionado após aceitar o convite. Utilizado apenas quando Personalizar convite está ativado.
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
#### UsageLocation
Código de país alfa-2 ISO 3166-1 para a localização de utilização do utilizador convidado (por exemplo, "US", "DE").
| Propriedade | Valor |
| ------------ | ------ |
| Obrigatório | falso |
| Valor padrão | |
| Tipo | String |
[Voltar à visão geral da referência do runbook](/pt/automacao/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 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://docs.realmjoin.com/pt/automacao/runbooks/runbook-references/org/general/invite-external-guest-users.md?ask=&goal=
```
`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.