---
title: "removeUserFromGroup"
canonical: "https://support.appfire.com/space/PSCONF/15304609/removeUserFromGroup"
format: markdown
---
> Macro (aura-html)

> Macro (table-plus)
> 
> |  |  |  |  |
> | --- | --- | --- | --- |
> | **Syntax** | removeUserFromGroup(userNameOrKey, groupName) | **Package** |  |
> | **Alias** |  | **Pkg Usage** |  |

## Description

> Macro (excerpt)
> 
> Removes a single user from a group if the user is in that group.

Removes a single user from a group if the user is in that group.

## Parameters

> Macro (table-plus)
> 
> | Parameter name | Type | Required | Description |
> | --- | --- | --- | --- |
> | userNameOrKey | String | Yes | User name or key of a user to remove from a group. |
> | groupName | String | Yes | Name of a group to remove user from. |

## Return Type

**Boolean (true/false)**

Returns true if a user was successfully removed from a group. Otherwise returns false.

## Example

```javascript
removeUserFromGroup("jdoe", "confluence-users");
```

Removes the "jdoe" user from the "confluence-users" group.

## See also

> Macro (contentbylabel)