Availability
This feature is available starting with v1.1.0 of the Power Scripts™ for Confluence.
Syntax
removeGroupFromContentPermission(permissionType, pageId, groupName)
Description
Removes a single group from a content permission if the group is in that permission.Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
permissionType | string | Yes | Permission type a group will be removed from. A list of values is provided in a table below. |
pageId | number | Yes | The ID of the page to remove permission from. |
| string | Yes | The name of a group to remove from permission. |
Valid content permission types
| Permission type | Description |
|---|---|
| View | Permission to view content. |
| Edit | Permission to edit content. |
Return type
boolean (true/false)
Returns true if the content permission was actually changed by the routine invocation, that is a group was actually removed from the specified content permission.
Returns false if the content permission was not changed.
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 content permission was not changed. For example, if the specified group wasn't in the specified content permission before the routine invocation, the routine will return false, because the state of the content permission was not changed. In order to check if the specified group has a certain content permission please use the following routine: groupHasContentPermission.
Example
Disallows members of the "confluence-users" group to modify page with id 11508.
removeGroupFromContentPermission("Edit", 11508, "confluence-users");
See also