addGroupToSpacePermission

Description

Adds a given group to a space permission if the group is not in that permission already.

Parameters

Return Type

Boolean (true/false)

Example

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

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

If the routine returns false, it doesn't mean that a group doesn't have the specified permission. It just means that the state of the space permission was not changed. For example, if the specified group was 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.

 

Permission Reference

Permission type

Description

Permission type

Description

USECONFLUENCE

Permission to use Confluence.

LIMITEDUSECONFLUENCE

Permission to limited usage of Confluence.

UPDATEUSERSTATUS

Permission to update user status.

VIEWUSERPROFILES

Permission to view user profiles.

SYSTEMADMINISTRATOR

Permission to be a system administrator.

ADMINISTRATECONFLUENCE

Permission to be a Confluence administrator.

PERSONALSPACE

Permission to work with personal space.

CREATESPACE

Permission to create a space.

VIEWSPACE

Permission to view a space.

REMOVEOWNCONTENT

Permission to remove own content.

COMMENT

Permission to add comments.

EDITSPACE

Permission to edit a space.

SETSPACEPERMISSIONS

Permission to update space permissions.

REMOVEPAGE

Permission to remove a page.

REMOVECOMMENT

Permission to remove a comment.

REMOVEBLOG

Permission to remove a blog.

CREATEATTACHMENT

Permission to create an attachment.

REMOVEATTACHMENT

Permission to remove an attachment.

EDITBLOG

Permission to edit a blog.

EXPORTSPACE

Permission to export a space.

REMOVEMAIL

Permission to remove email.

SETPAGEPERMISSIONS

Permission to update page permissions

PROFILEATTACHMENTS

Permission to work with profile attachments.

 

See also

Peacock