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

Class GroupLevelAdminResource

java.lang.Object

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

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

Represents a resource for managing group-level administrators.

Since:

3.3.0

Constructor Summary

Constructors

Constructor and Description
GroupLevelAdminResource(GroupLevelAdminController controller)

Method Summary

Modifier and Type	Method and Description
BatchResultWithFailureReasonsRestDto<DirectoryEntityRestDTO>	addGroupAdministrators(DirectoryEntityId groupId, List<DirectoryEntityRestDTO> grantEntities) Grants the rights to administer the specified group to the specified directory entities
javax.ws.rs.core.Response	deleteGroupGroupAdministrator(DirectoryEntityId targetGroupId, DirectoryEntityId adminId) Revokes the rights to administer the given group from the specified group
javax.ws.rs.core.Response	deleteUserGroupAdministrator(DirectoryEntityId targetGroupId, DirectoryEntityId adminId) Revokes the rights to administer the given group from the specified user
RestPage<GroupAdministrationMappingRestDTO>	getAdminCandidates(DirectoryEntityId groupId, String search, int limit) Returns users and groups that can become admins of the given group.
RestPage<GroupAdministrationMappingRestDTO>	getGroupAdministrators(DirectoryEntityId groupId, RestPageRequest pageRequest) Lists the group-level admins for the specified group

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupLevelAdminResource

@Inject
public GroupLevelAdminResource(GroupLevelAdminController controller)

Method Detail

getGroupAdministrators

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

Lists the group-level admins for the specified group

Parameters:

groupId - the identifier of the group

pageRequest - details about paging

Returns:

a paged list of group-level-administrators

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

addGroupAdministrators

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

Grants the rights to administer the specified group to the specified directory entities

Parameters:

groupId - the identifier of the group

grantEntities - the identifiers and types of entities that should become admins of the specified group

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

deleteUserGroupAdministrator

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

Revokes the rights to administer the given group from the specified user

Parameters:

targetGroupId - the identifier of the group to which the rights will be revoked

adminId - the identifier of the user from whom the rights will be revoked

Throws:

GroupNotFoundException

UserNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

deleteGroupGroupAdministrator

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

Revokes the rights to administer the given group from the specified group

Parameters:

targetGroupId - the identifier of the group to which the rights will be revoked

adminId - the identifier of the group from which the rights will be revoked

Throws:

GroupNotFoundException

DirectoryNotFoundException

OperationFailedException

FeatureInaccessibleException

getAdminCandidates

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

Returns users and groups that can become admins of the given group.

Parameters:

groupId - group to administer

search - user/group search string

limit - maximum number of results returned from the search

Throws:

DirectoryNotFoundException

IllegalAccessException

OperationFailedException

GroupNotFoundException

UserNotFoundException

FeatureInaccessibleException