removeUserFromGroup
Syntax | removeUserFromGroup(userNameOrKey, groupName) | Package | |
Alias | Pkg Usage |
Description
Removes a single user from a group if the user is in that group.
Parameters
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
removeUserFromGroup("jdoe", "confluence-users");Removes the "jdoe" user from the "confluence-users" group.