@Path(value="group-level-admin") @Consumes(value="application/json") @Produces(value="application/json") public class GroupLevelAdminResource extends Object
| Constructor and Description |
|---|
GroupLevelAdminResource(GroupLevelAdminController controller) |
| 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
|
@Inject public GroupLevelAdminResource(GroupLevelAdminController controller)
@GET
@Path(value="{groupId}/admins")
public RestPage<GroupAdministrationMappingRestDTO> getGroupAdministrators(@PathParam(value="groupId")
DirectoryEntityId groupId,
@Context
RestPageRequest pageRequest)
throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException
groupId - the identifier of the grouppageRequest - details about pagingGroupNotFoundExceptionDirectoryNotFoundExceptionOperationFailedExceptionFeatureInaccessibleException@POST
@Path(value="{groupId}/admins")
@ExperimentalApi
public BatchResultWithFailureReasonsRestDto<DirectoryEntityRestDTO> addGroupAdministrators(@PathParam(value="groupId")
DirectoryEntityId groupId,
List<DirectoryEntityRestDTO> grantEntities)
throws GroupNotFoundException,
DirectoryNotFoundException,
OperationFailedException,
FeatureInaccessibleException
groupId - the identifier of the groupgrantEntities - the identifiers and types of entities that should become admins of the specified groupGroupNotFoundExceptionDirectoryNotFoundExceptionOperationFailedExceptionFeatureInaccessibleException@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
targetGroupId - the identifier of the group to which the rights will be revokedadminId - the identifier of the user from whom the rights will be revokedGroupNotFoundExceptionUserNotFoundExceptionDirectoryNotFoundExceptionOperationFailedExceptionFeatureInaccessibleException@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
targetGroupId - the identifier of the group to which the rights will be revokedadminId - the identifier of the group from which the rights will be revokedGroupNotFoundExceptionDirectoryNotFoundExceptionOperationFailedExceptionFeatureInaccessibleException@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
groupId - group to administersearch - user/group search stringlimit - maximum number of results returned from the searchDirectoryNotFoundExceptionIllegalAccessExceptionOperationFailedExceptionGroupNotFoundExceptionUserNotFoundExceptionFeatureInaccessibleExceptionCopyright © 2023 Atlassian. All rights reserved.