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

Class UserAdminResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.admin.UserAdminResource

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

Represents a group-level admin resource for users view.

Since:

3.3.0

Constructor Summary

Constructors

Constructor and Description
UserAdminResource(UsersMembershipController usersMembershipController, UsersSearchController usersSearchController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addUserToGroups(DirectoryEntityId userId, GroupIdentifiersEntityList groups) Adds single user to multiple groups placed in the same directory
javax.ws.rs.core.Response	removeUserFromGroups(DirectoryEntityId userId, GroupIdentifiersEntityList groups) Removes multiple users from single group placed in the same directory
javax.ws.rs.core.Response	searchUsers(RestPageRequest pageRequest, UserSearchParams params) Returns users that can be assigned by to any group administered by the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAdminResource

public UserAdminResource(UsersMembershipController usersMembershipController,
                         UsersSearchController usersSearchController)

Method Detail

addUserToGroups

@POST
 @Path(value="/{userId}/groups")
public javax.ws.rs.core.Response addUserToGroups(@PathParam(value="userId")
                                                                                        DirectoryEntityId userId,
                                                                                        GroupIdentifiersEntityList groups)
                                                                                 throws UserNotFoundException,
                                                                                        DirectoryNotFoundException,
                                                                                        OperationFailedException,
                                                                                        FeatureInaccessibleException

Adds single user to multiple groups placed in the same directory

Parameters:

userId - User's unique identifier

groups - Entity with group's unique identifiers

Throws:

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

removeUserFromGroups

@DELETE
 @Path(value="/{userId}/groups")
public javax.ws.rs.core.Response removeUserFromGroups(@PathParam(value="userId")
                                                                                               DirectoryEntityId userId,
                                                                                               GroupIdentifiersEntityList groups)
                                                                                        throws UserNotFoundException,
                                                                                               DirectoryNotFoundException,
                                                                                               OperationFailedException,
                                                                                               FeatureInaccessibleException

Removes multiple users from single group placed in the same directory

Parameters:

userId - User's unique identifier

groups - Entity with group's unique identifiers

Throws:

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

searchUsers

@Path(value="/search")
 @POST
public javax.ws.rs.core.Response searchUsers(@Context
                                                                           RestPageRequest pageRequest,
                                                                           UserSearchParams params)
                                                                    throws DirectoryNotFoundException,
                                                                           OperationFailedException,
                                                                           IllegalAccessException,
                                                                           UserNotFoundException,
                                                                           FeatureInaccessibleException

Returns users that can be assigned by to any group administered by the current user.

Parameters:

pageRequest - starting index and maximum number of results returned from the search

params - search criteria

Throws:

DirectoryNotFoundException

OperationFailedException

IllegalAccessException

UserNotFoundException

FeatureInaccessibleException