nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How do I use the Confluence Java API to modify permissions on a page?

Tom Hudgins_rj2611

I'm trying to write a Scriptrunner for confluence script to modify the permissions of a page and I'm having trouble fully understanding the API.

I can get the permission set for a page/ceo but I'm not sure how to modify it and set the permissions back. I have this

def pageManager = ComponentLocator.getComponent(PageManager)

Page myPage = pageManager.getPage("SANDBOX","Perm Test")

ContentEntityObject ceo = myPage.getEntity()
ContentPermissionSet permSet = ceo.getContentPermissionSet(ContentPermission.EDIT_PERMISSION)

and I've tried various calls to

ContentPermissionManager.removeContentPermission(aPerm)

ContentPermissionManager.setContentPermissions(perms, ceo, ContentPermission.EDIT_PERMISSION)

but they throw errors so I'm not getting something right. I think I don't fully understand the concept so I'm not sure what to try.

Any help would be appreciated.

Accepted answers

Dominic Lagger_7f5sht

Hi @Tom Hudgins

Do you mean restrictions on a page?

I wrote a Script for this a while ago:

import com.atlassian.sal.api.component.ComponentLocator;
import com.atlassian.confluence.pages.PageManager;
import org.apache.log4j.Level
import org.apache.log4j.Logger
import com.atlassian.confluence.pages.Page
import com.atlassian.confluence.core.ContentPermissionManager
import com.atlassian.confluence.security.ContentPermission

import static com.atlassian.confluence.security.ContentPermission.EDIT_PERMISSION
import static com.atlassian.confluence.security.ContentPermission.VIEW_PERMISSION

class RestrictionHandler {
def addPermission(Long pageId, String... groups){
def log = Logger.getLogger("com.onresolve.scriptrunner.runner.ScriptRunnerImpl")
log.setLevel(Level.INFO)

def contentPermissionManager = ComponentLocator.getComponent(ContentPermissionManager)
PageManager pageManager = ComponentLocator.getComponent(PageManager)
Page page = pageManager.getPage(pageId)
log.info(page)

def permissions = []
groups.each{ group -> 
permissions.add(ContentPermission.createGroupPermission(VIEW_PERMISSION, group as String))
}

log.info(permissions)
def map = [(VIEW_PERMISSION): permissions] as Map
contentPermissionManager.setContentPermissions(map, page) 
}
}

And you can call it with this

RestrictionHandler handler = new RestrictionHandler()
String[] groups = ["GROUP_NAME1", "GROUP_NAME2"]
handler.addPermission(pageId, groups)

I think you should be able to change this to user as well.

Hope this helps. Let me know if you need further assistance.

Regards, Dominic

Dominic Lagger

Hi @Tom Hudgins

Do you mean restrictions on a page?

I wrote a Script for this a while ago:

import com.atlassian.sal.api.component.ComponentLocator;
import com.atlassian.confluence.pages.PageManager;
import org.apache.log4j.Level
import org.apache.log4j.Logger
import com.atlassian.confluence.pages.Page
import com.atlassian.confluence.core.ContentPermissionManager
import com.atlassian.confluence.security.ContentPermission

import static com.atlassian.confluence.security.ContentPermission.EDIT_PERMISSION
import static com.atlassian.confluence.security.ContentPermission.VIEW_PERMISSION

class RestrictionHandler {
def addPermission(Long pageId, String... groups){
def log = Logger.getLogger("com.onresolve.scriptrunner.runner.ScriptRunnerImpl")
log.setLevel(Level.INFO)

def contentPermissionManager = ComponentLocator.getComponent(ContentPermissionManager)
PageManager pageManager = ComponentLocator.getComponent(PageManager)
Page page = pageManager.getPage(pageId)
log.info(page)

def permissions = []
groups.each{ group -> 
permissions.add(ContentPermission.createGroupPermission(VIEW_PERMISSION, group as String))
}

log.info(permissions)
def map = [(VIEW_PERMISSION): permissions] as Map
contentPermissionManager.setContentPermissions(map, page) 
}
}

And you can call it with this

RestrictionHandler handler = new RestrictionHandler()
String[] groups = ["GROUP_NAME1", "GROUP_NAME2"]
handler.addPermission(pageId, groups)

I think you should be able to change this to user as well.

Hope this helps. Let me know if you need further assistance.

Regards, Dominic

All comments

Dominic Lagger_7f5sht

Hi @Tom Hudgins

Do you mean restrictions on a page?

I wrote a Script for this a while ago:

import com.atlassian.sal.api.component.ComponentLocator;
import com.atlassian.confluence.pages.PageManager;
import org.apache.log4j.Level
import org.apache.log4j.Logger
import com.atlassian.confluence.pages.Page
import com.atlassian.confluence.core.ContentPermissionManager
import com.atlassian.confluence.security.ContentPermission

import static com.atlassian.confluence.security.ContentPermission.EDIT_PERMISSION
import static com.atlassian.confluence.security.ContentPermission.VIEW_PERMISSION

class RestrictionHandler {
def addPermission(Long pageId, String... groups){
def log = Logger.getLogger("com.onresolve.scriptrunner.runner.ScriptRunnerImpl")
log.setLevel(Level.INFO)

def contentPermissionManager = ComponentLocator.getComponent(ContentPermissionManager)
PageManager pageManager = ComponentLocator.getComponent(PageManager)
Page page = pageManager.getPage(pageId)
log.info(page)

def permissions = []
groups.each{ group -> 
permissions.add(ContentPermission.createGroupPermission(VIEW_PERMISSION, group as String))
}

log.info(permissions)
def map = [(VIEW_PERMISSION): permissions] as Map
contentPermissionManager.setContentPermissions(map, page) 
}
}

And you can call it with this

RestrictionHandler handler = new RestrictionHandler()
String[] groups = ["GROUP_NAME1", "GROUP_NAME2"]
handler.addPermission(pageId, groups)

I think you should be able to change this to user as well.

Hope this helps. Let me know if you need further assistance.

Regards, Dominic

Dominic Lagger

Hi @Tom Hudgins

Do you mean restrictions on a page?

I wrote a Script for this a while ago:

import com.atlassian.sal.api.component.ComponentLocator;
import com.atlassian.confluence.pages.PageManager;
import org.apache.log4j.Level
import org.apache.log4j.Logger
import com.atlassian.confluence.pages.Page
import com.atlassian.confluence.core.ContentPermissionManager
import com.atlassian.confluence.security.ContentPermission

import static com.atlassian.confluence.security.ContentPermission.EDIT_PERMISSION
import static com.atlassian.confluence.security.ContentPermission.VIEW_PERMISSION

class RestrictionHandler {
def addPermission(Long pageId, String... groups){
def log = Logger.getLogger("com.onresolve.scriptrunner.runner.ScriptRunnerImpl")
log.setLevel(Level.INFO)

def contentPermissionManager = ComponentLocator.getComponent(ContentPermissionManager)
PageManager pageManager = ComponentLocator.getComponent(PageManager)
Page page = pageManager.getPage(pageId)
log.info(page)

def permissions = []
groups.each{ group -> 
permissions.add(ContentPermission.createGroupPermission(VIEW_PERMISSION, group as String))
}

log.info(permissions)
def map = [(VIEW_PERMISSION): permissions] as Map
contentPermissionManager.setContentPermissions(map, page) 
}
}

And you can call it with this

RestrictionHandler handler = new RestrictionHandler()
String[] groups = ["GROUP_NAME1", "GROUP_NAME2"]
handler.addPermission(pageId, groups)

I think you should be able to change this to user as well.

Hope this helps. Let me know if you need further assistance.

Regards, Dominic

Tom Hudgins_rj2611

Hi Dominic,

Many thanks for the help! I was able to put this together:

import com.atlassian.confluence.pages.Page
import com.atlassian.confluence.pages.PageManager
import com.atlassian.sal.api.component.ComponentLocator
import com.atlassian.confluence.core.ContentPermissionManager
import com.atlassian.confluence.security.ContentPermission
import com.atlassian.confluence.user.ConfluenceUser
import com.atlassian.user.UserManager

class UserRestrictions {

static addEditPerimission(List<Page> pages, ConfluenceUser user ) {
addPermission(pages, user, ContentPermission.EDIT_PERMISSION)
}

static addViewPerimission(List<Page> pages, ConfluenceUser user ) {
addPermission(pages, user, ContentPermission.VIEW_PERMISSION)
}

private static addPermission(List<Page> pages, ConfluenceUser user, String permissionType ) {
def permissions = []
permissions.add(ContentPermission.createUserPermission(permissionType, user))
def cpManager = ComponentLocator.getComponent(ContentPermissionManager)
pages.each {
cpManager.setContentPermissions(permissions, it, permissionType)
}
}
}

def userManager = ComponentLocator.getComponent(UserManager)

def myUser = (ConfluenceUser) userManager.getUser('dsta')

def pageManager = ComponentLocator.getComponent(PageManager)
Page myPage = pageManager.getPage("SANDBOX","Perm Test")

UserRestrictions.addEditPerimission([myPage], myUser)

One thing I can't seem to do is *remove* a permission/restriction for a user. Any ideas on that one?

Thanks,

Tom

Dominic Lagger

Hi @Tom Hudgins

Sorry for the confusion for my two identical answers. One is my leader account and one is an old one

About the remove:

If I can remember correctly, the addPermission removes every permission and set the new ones.

Can you deny or verify that?

Regards, Dominic

Tom Hudgins_rj2611

I don't think that's the case. As far as I can see it only adds the given permission. Everything else that is there stays there.

Tom

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

server

confluence-server

api

groovy