...
Table plus |
---|
applyColStyleToCell | true |
---|
columnTypes | s,s,s,s |
---|
heading | 0 |
---|
multiple | false |
---|
columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
---|
enableSorting | false |
---|
|
Syntax | removeGroupFromSpacePermission(permissionType, spaceKey, groupName) | Package | | Alias | | Pkg Usage | |
|
Description
Excerpt |
---|
|
Removes a single group from a space permission if the group is in that permission. |
Removes a single group from a space permission if the group is in that permission.
Parameters
Table plus |
---|
applyColStyleToCell | true |
---|
columnTypes | s,s,s,s |
---|
heading | 0 |
---|
multiple | false |
---|
enableSorting | false |
---|
|
Parameter name | Type | Required | Description |
---|
permissionType | String | Yes | Permission type a group will be removed from. A list of values is provided in a table. | spaceKey | String | Yes | The key of the space to remove permission from. | groupName | String | Yes | The name of a group to remove from permission. |
|
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
Code Block |
---|
|
removeGroupFromSpacePermission("EDITSPACE", "PS-DOCS", "confluence-users"); |
Disallows members of the "confluence-users" group to modify space with the "PS-DOCS" key.
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 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
Filter by label (Content by label) |
---|
showLabels | false |
---|
max | 25 |
---|
showSpace | false |
---|
cql | label = "group_routines" and space = currentSpace ( ) |
---|
labels | array_routines |
---|
|