> 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/automation/runbooks/runbook-references/org/general/invite-external-guest-users.md).

# Invite External Guest Users

### Description

This runbook invites an external user as a guest user in Microsoft Entra ID. Optional profile properties such as given name, surname, company name, usage location, manager, and sponsor can be set after the invitation is accepted. The invited user can optionally be added to a specified group.

### Location

Organization → General → Invite External Guest Users

**Full Runbook name**

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

### Permissions

#### Application permissions

* **Type**: Microsoft Graph
  * User.ReadWrite.All
  * Group.ReadWrite.All

### Parameters

#### InvitedUserEmail

Email address of the guest user to invite.

| Property      | Value  |
| ------------- | ------ |
| Required      | true   |
| Default Value |        |
| Type          | String |

#### InvitedUserDisplayName

Display name of the guest user.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### GroupId

The object ID of the group to add the guest user to. If not specified, the user will not be added to any group.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### GivenName

Given name (first name) of the guest user.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### Surname

Surname (last name) of the guest user.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### CompanyName

Company name of the guest user.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### ManagerName

Manager to assign to the guest user. Select a user from the directory.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### SponsorName

Sponsor to assign to the guest user. Select a user from the directory.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### CustomizeInvitation

Enable to customize the invitation message and redirect URL.

| Property      | Value   |
| ------------- | ------- |
| Required      | false   |
| Default Value | False   |
| Type          | Boolean |

#### InvitationMessage

Custom message body to include in the invitation email. Only used when CustomizeInvitation is enabled.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### InviteRedirectUrl

Custom URL the user is redirected to after accepting the invitation. Only used when CustomizeInvitation is enabled.

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

#### UsageLocation

ISO 3166-1 alpha-2 country code for the usage location of the guest user (e.g. "US", "DE").

| Property      | Value  |
| ------------- | ------ |
| Required      | false  |
| Default Value |        |
| Type          | String |

[Back to Runbook Reference overview](/automation/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:

```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references/org/general/invite-external-guest-users.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.