Package com.atlassian.bamboo.plugins.rest.permission

Class ProjectPlanPermissionsResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.permission.ProjectPlanPermissionsResource

All Implemented Interfaces:

PermissionsResource

@Path("permissions/projectplan")
@Produces("application/json")
@Consumes("application/json")
public class ProjectPlanPermissionsResource
extends Object
implements PermissionsResource

REST endpoint to manage user/group project plan permissions in Bamboo. Project plan permission is permission applied on project and defines base permissions for plans in that project. Additional permission for given plans can be applied on a plan level.

Since:

6.2

Field Summary

Fields inherited from interface com.atlassian.bamboo.plugins.rest.permission.PermissionsResource

ROLE_ANONYMOUS, ROLE_LOGGED_IN

Method Summary

Modifier and Type	Method	Description
boolean	addAnonymousPermissions(String key)
boolean	addGroupPermissions(String projectKey, String group, List<BambooPermission> permissionsToAdd)
boolean	addLoggedInPermissions(String projectKey, List<BambooPermission> permissionsToAdd)
jakarta.ws.rs.core.Response	addPermissionsForGroup(String projectKey, String group, List<String> permissionsToAdd)	Adds given permissions to group Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added
jakarta.ws.rs.core.Response	addPermissionsForRole(String projectKey, String role, List<String> permissionsToAdd)	Adds given permissions to role Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if all permissions were already added
jakarta.ws.rs.core.Response	addPermissionsForUser(String projectKey, String username, List<String> permissionsToAdd)	Adds given permissions to user Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added
boolean	addUserPermissions(String projectKey, String username, List<BambooPermission> permissionsToAdd)
List<BambooPermission>	getAnonymousPermissions(String projectKey)
RestPageModel<RestGroup>	getAvailableGroups(String projectKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a paged list of groups RestGroup for which no permissions was defined.
RestPageModel<RestUser>	getAvailableUsers(String projectKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a paged list of users RestUser for which no permissions was defined.
List<BambooPermission>	getGroupPermissions(String projectKey, String group)
List<BambooPermission>	getLoggedInPermissions(String projectKey)
List<BambooPermission>	getUserPermissions(String projectKey, String username)
default boolean	isPermissionVisible(@NotNull BambooPermission permission)
RestPageModel<RestGroupPermission>	listGroupPermissions(String projectKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a paged list of groups RestGroupPermission with non empty permissions
Iterable<String>	listGroupsWithPermissions(String projectKey)
RestPageModel<RestRolePermission>	listRolePermissions(String projectKey, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a paged list of roles RestRolePermission with non empty permissions
RestPageModel<RestUserPermission>	listUserPermissions(String projectKey, String nameFilter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a paged list of users RestUserPermission with non empty permissions
Iterable<String>	listUsersWithPermissions(String projectKey)
Collection<BambooPermission>	permissionDependencies(@NotNull BambooPermission permission)
boolean	removeAnonymousPermissions(String key)
boolean	removeGroupPermissions(String projectKey, String group, List<BambooPermission> permissionsToRemove)
boolean	removeLoggedInPermissions(String projectKey, List<BambooPermission> permissionsToRemove)
jakarta.ws.rs.core.Response	removePermissionsForGroup(String projectKey, String group, List<String> permissionsToRemove)	Removes given permissions from group Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
jakarta.ws.rs.core.Response	removePermissionsForRole(String projectKey, String role, List<String> permissionsToRemove)	Removes given permissions from role Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
jakarta.ws.rs.core.Response	removePermissionsForUser(String projectKey, String username, List<String> permissionsToRemove)	Removes given permissions from user Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present
boolean	removeUserPermissions(String projectKey, String username, List<BambooPermission> permissionsToRemove)
Collection<BambooPermission>	supportedPermissions()
Set<String>	supportedRoles()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listUserPermissions

@GET
@Path("{key}/users")
public RestPageModel<RestUserPermission> listUserPermissions(@PathParam("key")
 String projectKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of users RestUserPermission with non empty permissions

Specified by:

listUserPermissions in interface PermissionsResource

addPermissionsForUser

@PUT
@Path("{key}/users/{name : (.+)?}")
public jakarta.ws.rs.core.Response addPermissionsForUser(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String username,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to user Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added

Specified by:

addPermissionsForUser in interface PermissionsResource

removePermissionsForUser

@DELETE
@Path("{key}/users/{name : (.+)?}")
public jakarta.ws.rs.core.Response removePermissionsForUser(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String username,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from user Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForUser in interface PermissionsResource

getAvailableUsers

@GET
@Path("{key}/available-users")
public RestPageModel<RestUser> getAvailableUsers(@PathParam("key")
 String projectKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of users RestUser for which no permissions was defined. Allows to filter by user name

Specified by:

getAvailableUsers in interface PermissionsResource

listGroupPermissions

@GET
@Path("{key}/groups")
public RestPageModel<RestGroupPermission> listGroupPermissions(@PathParam("key")
 String projectKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of groups RestGroupPermission with non empty permissions

Specified by:

listGroupPermissions in interface PermissionsResource

addPermissionsForGroup

@PUT
@Path("{key}/groups/{name : (.+)?}")
public jakarta.ws.rs.core.Response addPermissionsForGroup(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String group,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to group Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if given permissions were already added

Specified by:

addPermissionsForGroup in interface PermissionsResource

removePermissionsForGroup

@DELETE
@Path("{key}/groups/{name : (.+)?}")
public jakarta.ws.rs.core.Response removePermissionsForGroup(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String group,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from group Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForGroup in interface PermissionsResource

getAvailableGroups

@GET
@Path("{key}/available-groups")
public RestPageModel<RestGroup> getAvailableGroups(@PathParam("key")
 String projectKey,
 @QueryParam("name")
 String nameFilter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of groups RestGroup for which no permissions was defined. Allows to filter by group name

Specified by:

getAvailableGroups in interface PermissionsResource

listRolePermissions

@GET
@Path("{key}/roles")
public RestPageModel<RestRolePermission> listRolePermissions(@PathParam("key")
 String projectKey,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Description copied from interface: PermissionsResource

Returns a paged list of roles RestRolePermission with non empty permissions

Specified by:

listRolePermissions in interface PermissionsResource

addPermissionsForRole

@PUT
@Path("{key}/roles/{name : (.+)?}")
public jakarta.ws.rs.core.Response addPermissionsForRole(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String role,
 List<String> permissionsToAdd)

Description copied from interface: PermissionsResource

Adds given permissions to role Returns status code 204 Response.Status.NO_CONTENT if any permission was added or status code 304 Response.Status.NOT_MODIFIED if all permissions were already added

Specified by:

addPermissionsForRole in interface PermissionsResource

removePermissionsForRole

@DELETE
@Path("{key}/roles/{name : (.+)?}")
public jakarta.ws.rs.core.Response removePermissionsForRole(@PathParam("key")
 String projectKey,
 @PathParam("name")
 String role,
 List<String> permissionsToRemove)

Description copied from interface: PermissionsResource

Removes given permissions from role Returns status code 204 Response.Status.NO_CONTENT if any permission was removed or status code 304 Response.Status.NOT_MODIFIED if given permissions were not present

Specified by:

removePermissionsForRole in interface PermissionsResource

supportedRoles

public Set<String> supportedRoles()

supportedPermissions

public Collection<BambooPermission> supportedPermissions()

permissionDependencies

public Collection<BambooPermission> permissionDependencies(@NotNull
 @NotNull BambooPermission permission)

listUsersWithPermissions

public Iterable<String> listUsersWithPermissions(String projectKey)

getUserPermissions

public List<BambooPermission> getUserPermissions(String projectKey,
 String username)

addUserPermissions

public boolean addUserPermissions(String projectKey,
 String username,
 List<BambooPermission> permissionsToAdd)

removeUserPermissions

public boolean removeUserPermissions(String projectKey,
 String username,
 List<BambooPermission> permissionsToRemove)

listGroupsWithPermissions

public Iterable<String> listGroupsWithPermissions(String projectKey)

getGroupPermissions

public List<BambooPermission> getGroupPermissions(String projectKey,
 String group)

addGroupPermissions

public boolean addGroupPermissions(String projectKey,
 String group,
 List<BambooPermission> permissionsToAdd)

removeGroupPermissions

public boolean removeGroupPermissions(String projectKey,
 String group,
 List<BambooPermission> permissionsToRemove)

getLoggedInPermissions

public List<BambooPermission> getLoggedInPermissions(String projectKey)

addLoggedInPermissions

public boolean addLoggedInPermissions(String projectKey,
 List<BambooPermission> permissionsToAdd)

removeLoggedInPermissions

public boolean removeLoggedInPermissions(String projectKey,
 List<BambooPermission> permissionsToRemove)

getAnonymousPermissions

public List<BambooPermission> getAnonymousPermissions(String projectKey)

addAnonymousPermissions

public boolean addAnonymousPermissions(String key)

removeAnonymousPermissions

public boolean removeAnonymousPermissions(String key)

isPermissionVisible

default boolean isPermissionVisible(@NotNull
 @NotNull BambooPermission permission)