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

Class UserAdminResource

java.lang.Object

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

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

Represents a group-level admin resource for users view.

Since:

3.3.0

Constructor Summary

Constructors

Constructor	Description
UserAdminResource(UsersMembershipController usersMembershipController, UsersSearchController usersSearchController)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addUserToGroups(DirectoryEntityId userId, GroupIdentifiersEntityList groups)
javax.ws.rs.core.Response	removeUserFromGroups(DirectoryEntityId userId, GroupIdentifiersEntityList groups)
javax.ws.rs.core.Response	searchUsers(RestPageRequest pageRequest, UserSearchParams params)

Methods inherited from class java.lang.Object

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

Constructor Details

UserAdminResource

@Inject
public UserAdminResource(UsersMembershipController usersMembershipController,
 UsersSearchController usersSearchController)

Method Details

addUserToGroups

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

Throws:

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

removeUserFromGroups

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

Throws:

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

searchUsers

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

Throws:

DirectoryNotFoundException

OperationFailedException

IllegalAccessException

UserNotFoundException

FeatureInaccessibleException