Package com.atlassian.crowd.plugin.rest.service.resource.memberships

Class GroupsMembershipResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.memberships.GroupsMembershipResource

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

Represents a resource for managing groups.

Since:

3.3.0

Constructor Summary

Constructors

Constructor	Description
GroupsMembershipResource(GroupsMembershipController groupsMembershipController, UsersSearchController usersSearchController)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addUsersToGroup(DirectoryEntityId groupId, UserIdentifiersEntityList users)
javax.ws.rs.core.Response	groupDetails(DirectoryEntityId groupId)
javax.ws.rs.core.Response	groupMembers(RestPageRequest pageRequest, DirectoryEntityId groupId)
javax.ws.rs.core.Response	removeUsersFromGroup(DirectoryEntityId groupId, UserIdentifiersEntityList users)
javax.ws.rs.core.Response	searchAdministeredGroups(RestPageRequest pageRequest, GroupsFilter groupsFilter)
javax.ws.rs.core.Response	searchUsers(DirectoryEntityId groupId, String userSearch, int limit)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupsMembershipResource

@Inject
public GroupsMembershipResource(GroupsMembershipController groupsMembershipController,
 UsersSearchController usersSearchController)

Method Details

searchAdministeredGroups

@POST
@Path("/query")
public javax.ws.rs.core.Response searchAdministeredGroups(@BeanParam
 RestPageRequest pageRequest,
 GroupsFilter groupsFilter)
                                                   throws DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

groupDetails

@GET
@Path("/{groupId}")
public javax.ws.rs.core.Response groupDetails(@PathParam("groupId")
 DirectoryEntityId groupId)
                                       throws DirectoryNotFoundException,
GroupNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

GroupNotFoundException

OperationFailedException

FeatureInaccessibleException

groupMembers

@GET
@Path("/{groupId}/users")
public javax.ws.rs.core.Response groupMembers(@BeanParam
 RestPageRequest pageRequest,
 @PathParam("groupId")
 DirectoryEntityId groupId)
                                       throws DirectoryNotFoundException,
OperationFailedException,
GroupNotFoundException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

OperationFailedException

GroupNotFoundException

FeatureInaccessibleException

addUsersToGroup

@POST
@Path("/{groupId}/users/")
public javax.ws.rs.core.Response addUsersToGroup(@PathParam("groupId")
 DirectoryEntityId groupId,
 UserIdentifiersEntityList users)
                                          throws DirectoryNotFoundException,
GroupNotFoundException,
OperationFailedException,
DirectoryPermissionException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

GroupNotFoundException

OperationFailedException

DirectoryPermissionException

FeatureInaccessibleException

removeUsersFromGroup

@DELETE
@Path("/{groupId}/users")
public javax.ws.rs.core.Response removeUsersFromGroup(@PathParam("groupId")
 DirectoryEntityId groupId,
 UserIdentifiersEntityList users)
                                               throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

searchUsers

@Path("/{groupId}/users/suggestions")
@GET
public javax.ws.rs.core.Response searchUsers(@PathParam("groupId")
 DirectoryEntityId groupId,
 @QueryParam("search")
 String userSearch,
 @QueryParam("limit") @DefaultValue("100")
 int limit)
                                      throws DirectoryNotFoundException,
OperationFailedException,
UserNotFoundException,
GroupNotFoundException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

OperationFailedException

UserNotFoundException

GroupNotFoundException

FeatureInaccessibleException