> 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/group/general/add-or-remove-user.md).

# Add Or Remove User

Add a user to this group or remove one

### Description

Adds a user as a member of this group or removes an existing member. Works for Microsoft Entra ID groups as well as Exchange Online distribution and mail-enabled security groups.

### Location

Group → General → Add Or Remove User

**Full Runbook name**

rjgit-group\_general\_add-or-remove-user

### Details

| Property         | Value                               |
| ---------------- | ----------------------------------- |
| Version          | 1.0.3                               |
| Required modules | RealmJoin.RunbookHelper (>= 0.8.10) |
| Schedulable      | no                                  |

### Permissions

#### Application permissions

* **Type**: Microsoft Graph
  * User.Read.All
    * *Resolves the target user before adding or removing the membership*
  * Group.ReadWrite.All
    * *Reads the target group and backs the member changes*
  * GroupMember.ReadWrite.All
    * *Checks membership and adds or removes the user via /groups/{id}/members/$ref*
* **Type**: Office 365 Exchange Online
  * Exchange.ManageAsApp *(optional — feature: Mail-enabled groups)*
    * *Manages members via the Exchange Online distribution group cmdlets*

#### RBAC roles

* Exchange Administrator
  * *Required for the app-only Exchange Online session managing distribution group members*

### Parameters

#### GroupID

Object ID of the group the runbook acts on. Set by the portal from the selected group.

| Property         | Value                                  |
| ---------------- | -------------------------------------- |
| Required         | true                                   |
| Default Value    |                                        |
| Type             | String                                 |
| Hidden in portal | yes (preset via runbook customization) |

#### UserId

User who is added to or removed from the group.

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

#### Remove

Add makes the user a member. Remove takes the membership away.

| Property            | Value   |
| ------------------- | ------- |
| Required            | false   |
| Default Value       | False   |
| Type                | Boolean |
| Portal display name | Action  |

**Portal options**

| Portal option         | Value |
| --------------------- | ----- |
| Add user as member    | false |
| Remove user as member | true  |

[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 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/automation/runbooks/runbook-references/group/general/add-or-remove-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.