Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This feature is available starting with v1.1.0 of the Power Scripts™ for Confluence.
Info
titleAvailability
Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

removeGroupFromContentPermission(permissionType, pageId, groupName)

Package

Alias

Pkg Usage

Description

Excerpt
hiddentrue

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

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

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

permissionType

...

String

Yes

Permission type a group will be removed from.

...

Valid types (View, Edit).

pageId

...

Number

Yes

The ID of the page to remove permission from.

groupName

...

String

Yes

The name of a group to remove from

...

permission

...

.

Return

...

Type

boolean 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.

Example

Disallows members of the "confluence-users" group to modify page with id 11508.

Code Block
languagejs
removeGroupFromContentPermission("Edit", 11508, "confluence-users");

Note

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

.

Code Block
removeGroupFromContentPermission("Edit", 11508, "confluence-users");

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "

...

group_

...

routines" and space = currentSpace ( )
labels

...

array_

...

routines