Package com.atlassian.bamboo.plugins.rest.user

Class GroupAdminResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.user.GroupAdminResource

@Path("admin/groups")
@Consumes("application/json")
@Produces("application/json")
public class GroupAdminResource
extends Object

REST resource to manage groups in Bamboo.

Since:

6.6

Constructor Summary

Constructors

Constructor	Description
GroupAdminResource(BambooPermissionManager bambooPermissionManager, BambooUserManager userManager, com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate, org.apache.struts2.text.TextProvider textProvider, PaginationService paginationService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addUsersToGroup(String groupName, List<String> usersToAdd)
jakarta.ws.rs.core.Response	createGroup(RestGroup group)
jakarta.ws.rs.core.Response	deleteGroup(String groupName)
RestPageModel<RestUserDetails>	findUsersInGroup(String groupName, String filter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestUserDetails>	findUsersNotInGroup(String groupName, String filter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestGroup>	getGroups(String filter, PageRequest pageRequest, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	removeUsersFromGroup(String groupName, List<String> usersToRemove)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupAdminResource

@Inject
public GroupAdminResource(BambooPermissionManager bambooPermissionManager,
 BambooUserManager userManager,
 com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate,
 org.apache.struts2.text.TextProvider textProvider,
 PaginationService paginationService)

Method Details

getGroups

@GET
public RestPageModel<RestGroup> getGroups(@QueryParam("filter") @DefaultValue("")
 String filter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                   throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException

createGroup

@POST
public jakarta.ws.rs.core.Response createGroup(RestGroup group)
                                        throws WebValidationException

Throws:

WebValidationException

deleteGroup

@DELETE
@Path("{name : (.+)?}")
public jakarta.ws.rs.core.Response deleteGroup(@PathParam("name")
 String groupName)
                                        throws WebValidationException

Throws:

WebValidationException

addUsersToGroup

@POST
@Path("{name : (.+)?}/add-users")
public jakarta.ws.rs.core.Response addUsersToGroup(@PathParam("name")
 String groupName,
 List<String> usersToAdd)
                                            throws WebValidationException

Throws:

WebValidationException

removeUsersFromGroup

@DELETE
@Path("{name : (.+)?}/remove-users")
public jakarta.ws.rs.core.Response removeUsersFromGroup(@PathParam("name")
 String groupName,
 List<String> usersToRemove)
                                                 throws WebValidationException

Throws:

WebValidationException

findUsersInGroup

@GET
@Path("{name : (.+)?}/more-members")
public RestPageModel<RestUserDetails> findUsersInGroup(@PathParam("name")
 String groupName,
 @QueryParam("filter") @DefaultValue("")
 String filter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

findUsersNotInGroup

@GET
@Path("{name : (.+)?}/more-non-members")
public RestPageModel<RestUserDetails> findUsersNotInGroup(@PathParam("name")
 String groupName,
 @QueryParam("filter") @DefaultValue("")
 String filter,
 @BeanParam
 PageRequest pageRequest,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                                   throws com.atlassian.user.EntityException

Throws:

com.atlassian.user.EntityException