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

Class GroupLevelAdminResource

java.lang.Object

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

@Path("group-level-admin")
@Consumes("application/json")
@Produces("application/json")
public class GroupLevelAdminResource
extends Object

Represents a resource for managing group-level administrators.

Since:

3.3.0

Constructor Summary

Constructors

Constructor	Description
GroupLevelAdminResource(GroupLevelAdminController controller)

Method Summary

Modifier and Type	Method	Description
BatchResultWithFailureReasonsRestDto<DirectoryEntityRestDTO>	addGroupAdministrators(DirectoryEntityId groupId, List<DirectoryEntityRestDTO> grantEntities)
javax.ws.rs.core.Response	deleteGroupGroupAdministrator(DirectoryEntityId targetGroupId, DirectoryEntityId adminId)
javax.ws.rs.core.Response	deleteUserGroupAdministrator(DirectoryEntityId targetGroupId, DirectoryEntityId adminId)
RestPage<GroupAdministrationMappingRestDTO>	getAdminCandidates(DirectoryEntityId groupId, String search, int limit)
RestPage<GroupAdministrationMappingRestDTO>	getGroupAdministrators(RestPageRequest pageRequest, DirectoryEntityId groupId)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupLevelAdminResource

@Inject
public GroupLevelAdminResource(GroupLevelAdminController controller)

Method Details

getGroupAdministrators

@GET
@Path("{groupId}/admins")
public RestPage<GroupAdministrationMappingRestDTO> getGroupAdministrators(@BeanParam
 RestPageRequest pageRequest,
 @PathParam("groupId")
 DirectoryEntityId groupId)
                                                                   throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

addGroupAdministrators

@POST
@Path("{groupId}/admins")
public BatchResultWithFailureReasonsRestDto<DirectoryEntityRestDTO> addGroupAdministrators(@PathParam("groupId")
 DirectoryEntityId groupId,
 List<DirectoryEntityRestDTO> grantEntities)
                                                                                    throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

deleteUserGroupAdministrator

@DELETE
@Path("{groupId}/admins/users/{adminId}")
public javax.ws.rs.core.Response deleteUserGroupAdministrator(@PathParam("groupId")
 DirectoryEntityId targetGroupId,
 @PathParam("adminId")
 DirectoryEntityId adminId)
                                                       throws GroupNotFoundException,
UserNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

GroupNotFoundException

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

deleteGroupGroupAdministrator

@DELETE
@Path("{groupId}/admins/groups/{adminId}")
public javax.ws.rs.core.Response deleteGroupGroupAdministrator(@PathParam("groupId")
 DirectoryEntityId targetGroupId,
 @PathParam("adminId")
 DirectoryEntityId adminId)
                                                        throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

getAdminCandidates

@GET
@Path("{groupId}/admins/suggestions")
public RestPage<GroupAdministrationMappingRestDTO> getAdminCandidates(@PathParam("groupId")
 DirectoryEntityId groupId,
 @QueryParam("search")
 String search,
 @QueryParam("limit") @DefaultValue("100")
 int limit)
                                                               throws DirectoryNotFoundException,
IllegalAccessException,
OperationFailedException,
GroupNotFoundException,
UserNotFoundException,
FeatureInaccessibleException

Throws:

DirectoryNotFoundException

IllegalAccessException

OperationFailedException

GroupNotFoundException

UserNotFoundException

FeatureInaccessibleException