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

Class GroupsMembershipResource

java.lang.Object

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

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

Represents a resource for managing groups.

Since:

3.3.0

Constructor Summary

Constructors

Constructor and Description
GroupsMembershipResource(GroupsMembershipController groupsMembershipController, UsersSearchController usersSearchController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUsersToGroup(DirectoryEntityId groupId, UserIdentifiersEntityList users) Adds multiple users to a single group placed in the same directory
javax.ws.rs.core.Response	groupDetails(DirectoryEntityId groupId) Returns group details
javax.ws.rs.core.Response	groupMembers(DirectoryEntityId groupId, RestPageRequest pageRequest) Returns group's direct members (users).
javax.ws.rs.core.Response	removeUsersFromGroup(DirectoryEntityId groupId, UserIdentifiersEntityList users) Removes multiple users from single group placed in the same directory
javax.ws.rs.core.Response	searchAdministeredGroups(RestPageRequest pageRequest, GroupsFilter groupsFilter) Returns groups that are administered by logged in user
javax.ws.rs.core.Response	searchUsers(DirectoryEntityId groupId, String userSearch, int limit) Returns users that can be assigned to the given group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsMembershipResource

public GroupsMembershipResource(GroupsMembershipController groupsMembershipController,
                                UsersSearchController usersSearchController)

Method Detail

searchAdministeredGroups

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

Returns groups that are administered by logged in user

Parameters:

pageRequest - details about paging

groupsFilter - the filter that the result should match

Throws:

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

groupDetails

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

Returns group details

Parameters:

groupId - Group's unique identifier

Throws:

DirectoryNotFoundException

GroupNotFoundException

OperationFailedException

FeatureInaccessibleException

groupMembers

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

Returns group's direct members (users).

Parameters:

groupId - Group's unique identifier

Throws:

DirectoryNotFoundException

OperationFailedException

GroupNotFoundException

FeatureInaccessibleException

addUsersToGroup

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

Adds multiple users to a single group placed in the same directory

Parameters:

groupId - Group's unique identifier

users - Entity with user's unique identifiers

Throws:

DirectoryNotFoundException

GroupNotFoundException

OperationFailedException

DirectoryPermissionException

FeatureInaccessibleException

removeUsersFromGroup

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

Removes multiple users from single group placed in the same directory

Parameters:

groupId - Group's unique identifier

users - Entity with user's unique identifiers

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

searchUsers

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

Returns users that can be assigned to the given group.

Parameters:

groupId - group to which users would be assigned

userSearch - user search string

limit - maximum number of results returned from the search

Throws:

DirectoryNotFoundException

OperationFailedException

UserNotFoundException

GroupNotFoundException

FeatureInaccessibleException