Package com.atlassian.confluence.plugins.restapi.resources

Class GroupResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.GroupResource

@ExperimentalApi
@Consumes("application/json")
@Produces("application/json")
@Path("/group")
public class GroupResource
extends Object

Non-admin operations for user groups

Constructor Summary

Constructors

Constructor	Description
GroupResource(GroupService groupService, PersonService personService)

Method Summary

Modifier and Type	Method	Description
PageResponse<Group>	getAncestorGroups(Group group, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Group>	getAncestorGroupsByGroupName(String groupName, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
Group	getGroup(String groupName, String expand)
Group	getGroupByGroupName(String groupName, String expand)
PageResponse<Group>	getGroups(String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Person>	getMembers(Group group, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Person>	getMembersByGroupName(String groupName, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Group>	getNestedGroupMembers(Group group, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Group>	getNestedGroupMembersByGroupName(String groupName, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Group>	getParentGroups(Group group, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
PageResponse<Group>	getParentGroupsByGroupName(String groupName, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupResource

@Inject
public GroupResource(GroupService groupService,
 PersonService personService)

Method Details

getGroups

@GET
public PageResponse<Group> getGroups(@QueryParam("expand") @DefaultValue("")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getGroup

@GET
@Path("{groupName}")
public Group getGroup(@PathParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand)

getGroupByGroupName

@GET
@Path("info")
public Group getGroupByGroupName(@QueryParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand)

getMembers

@GET
@Path("{groupName}/member")
public PageResponse<Person> getMembers(@PathParam("groupName")
 Group group,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getMembersByGroupName

@GET
@Path("member")
public PageResponse<Person> getMembersByGroupName(@QueryParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getNestedGroupMembers

@GET
@Path("{groupName}/groupmember")
public PageResponse<Group> getNestedGroupMembers(@PathParam("groupName")
 Group group,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getNestedGroupMembersByGroupName

@GET
@Path("groupmember")
public PageResponse<Group> getNestedGroupMembersByGroupName(@QueryParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getParentGroups

@GET
@Path("{groupName}/groupparent")
public PageResponse<Group> getParentGroups(@PathParam("groupName")
 Group group,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getParentGroupsByGroupName

@GET
@Path("groupparent")
public PageResponse<Group> getParentGroupsByGroupName(@QueryParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getAncestorGroups

@GET
@Path("{groupName}/groupancestor")
public PageResponse<Group> getAncestorGroups(@PathParam("groupName")
 Group group,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getAncestorGroupsByGroupName

@GET
@Path("groupancestor")
public PageResponse<Group> getAncestorGroupsByGroupName(@QueryParam("groupName")
 String groupName,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)