> 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 de perfil como nome, empresa, local de uso, gerente e patrocinador são definidos imediatamente na conta de convidado. O e-mail de convite e a página de destino podem ser personalizados. Sem o e-mail, a saída do trabalho mostra o link que o convidado usa para aceitar o convite.

### 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 de perfil e de grupo podem ser deixados em branco.
* Onboarding completo: forneça todos os campos opcionais para definir propriedades do perfil, atribuir um gerente e um patrocinador e adicionar o convidado a um grupo em uma única execução.

### Interações entre parâmetros

* Propriedades do perfil (`givenName`, `surname`, `companyName`, `usageLocation`) são aplicadas apenas quando não estão vazias; omiti-las ignora completamente a chamada de atualização.
* A atribuição de gerente, a atribuição de patrocinador e a associação ao grupo exigem seus respectivos parâmetros; todos são ignorados silenciosamente quando não fornecidos.
* O local de uso deve ser um código de país ISO 3166-1 de duas letras, por exemplo `GB` para o Reino Unido (não `UK`) e `GR` para a Grécia (não `EL`). Um código desconhecido interrompe a execução antes de o convite ser enviado, portanto nenhuma conta de convidado e nenhum e-mail de convite são criados.

### Convite sem e-mail

Quando "Enviar o e-mail de convite?" está desativado, o Entra ID cria a conta de convidado sem enviar um e-mail, da mesma forma que limpar "Enviar mensagem de convite" no centro de administração do Entra. O convidado permanece no estado "pendente de aceitação" até o primeiro início de sessão.

* A saída do trabalho mostra o link de resgate uma vez, na seção "Convidar usuário convidado". Passe-o ao convidado por outro canal, por exemplo, seu próprio e-mail ou uma mensagem de chat.
* Em vez do link de resgate, o convidado pode entrar por meio de um link que contém o seu Tenant, por exemplo `https://myapps.microsoft.com/?tenantid=<tenant id>`. O prompt de consentimento aparece no primeiro início de sessão.
* Os convidados que entrarem com um alias do endereço convidado precisam do link de resgate.
* A URL de redirecionamento de "Personalizar o convite?" ainda se aplica: após aceitar por meio do link de resgate, o convidado será direcionado para lá.
* A mensagem de convite faz parte apenas do e-mail e não é usada sem ele.

### Localização

Organização → Geral → Convidar usuários convidados externos

**Nome completo do runbook**

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

### Detalhes

| Propriedade         | Valor                                                                                    |
| ------------------- | ---------------------------------------------------------------------------------------- |
| Versão              | 2.1.0                                                                                    |
| 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 de aplicativo

* **Tipo**: Microsoft Graph
  * Group.ReadWrite.All
    * *Verifica o grupo de destino e adiciona o convidado por meio de /groups/{id}/members/$ref*
  * Organization.Read.All
    * *Lê o ID do Tenant para criar a URL padrão de redirecionamento do convite*
  * User.ReadWrite.All
    * *Cria o convite, aplica patch nas propriedades do perfil do convidado e define o gerente e o patrocinador*

### Parâmetros

#### InvitedUserEmail

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

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

#### InvitedUserDisplayName

Nome exibido para o convidado no diretório.

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

#### GroupId

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

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

#### GivenName

Nome do convidado.

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

#### Sobrenome

Sobrenome do convidado.

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

#### CompanyName

Empresa para a qual o convidado trabalha.

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

#### ManagerName

Usuário que se torna o gerente do convidado.

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

#### SponsorName

Usuário registrado como patrocinador do convidado.

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

#### SendInvitationMessage

Envia o convite por e-mail ao convidado. Sem o e-mail, a saída do trabalho mostra o link que o convidado usa para aceitar o convite, para ser repassado por outros meios.

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

#### CustomizeInvitation

Mostra campos para uma mensagem de convite própria e URL de redirecionamento.

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

#### InvitationMessage

Texto incluído no e-mail de convite. Não usado quando nenhum e-mail de convite é enviado.

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

#### InviteRedirectUrl

Página para a qual o convidado é direcionado após aceitar, por exemplo, um site do SharePoint.

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

#### UsageLocation

Código de país ISO de duas letras, por exemplo US, DE ou GB para o Reino Unido, necessário antes que licenças possam ser atribuídas. Um código desconhecido como UK interrompe a execução antes de o convite ser enviado.

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

[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/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.
