removeGroupFromSpacePermission routine

Owned by Jonathan Muse
Last updated: Oct 16, 2024 by Shane Smith
1 min read

Description

Removes a single group from a space permission if the group is in that permission.

Parameters

Return Type

Boolean (true/false)

Returns true if space permission was actually changed by the routine invocation, i.e. a group was actually added to the specified space permission. Returns false if a space permission was not changed.

Example

removeGroupFromSpacePermission("EDITSPACE", "PS-DOCS", "confluence-users");

Disallows members of the "confluence-users" group to modify space with the "PS-DOCS" key.

 

If the routine returns false, it doesn't mean that the specified permission still exists for the group. It just means that the state of the space permission was not changed. For example, if the specified group wasn't in the specified space permission before the routine invocation, the routine will return false, because the state of the space permission was not changed. In order to check if the specified group has a certain space permission please use the following routine: groupHasSpacePermission.

See also

Peacock