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

Class UserResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.UserResource

@Consumes("application/json")
@Produces("application/json")
@Path("/user")
public class UserResource
extends Object

Non-admin user operations

Constructor Summary

Constructors

Constructor	Description
UserResource(PersonService personService, GroupService groupService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	changePassword(PasswordChangeDetails passwordChangeDetails)
Person	getAnonymous()
Person	getCurrent(String expand)
PageResponse<Group>	getGroups(String userKey, String username, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
Person	getUser(String key, String username, String expand)
Person	getUserGraph(boolean current, String key, String username, String expand)
PageResponse<Person>	getUsers(String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	updateUser(UserDetailsForUpdate userDetailsForUpdate, 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

UserResource

@Inject
public UserResource(PersonService personService,
 GroupService groupService)

Method Details

getUserGraph

public Person getUserGraph(@DefaultValue("false")
 boolean current,
 String key,
 String username,
 String expand)

getUser

@GET
public Person getUser(@QueryParam("key")
 String key,
 @QueryParam("username")
 String username,
 @QueryParam("expand")
 String expand)

getUsers

@GET
@Path("/list")
public PageResponse<Person> getUsers(@QueryParam("expand") @DefaultValue("")
 String expand,
 @QueryParam("start") @DefaultValue("0")
 int start,
 @QueryParam("limit") @DefaultValue("100")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getCurrent

@GET
@Path("/current")
public Person getCurrent(@QueryParam("expand")
 String expand)

getAnonymous

@GET
@Path("/anonymous")
public Person getAnonymous()

getGroups

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

changePassword

@POST
@Path("/current/password")
@Consumes("application/json")
public jakarta.ws.rs.core.Response changePassword(PasswordChangeDetails passwordChangeDetails)

updateUser

@PUT
@Path("/current")
@Consumes("application/json")
public jakarta.ws.rs.core.Response updateUser(UserDetailsForUpdate userDetailsForUpdate,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)