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

Class UserGroupResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.UserGroupResource

public final class UserGroupResource
extends Object

REST API for managing User to Group membership.

Since:

8.2.0

Constructor Summary

Constructors

Constructor	Description
UserGroupResource(PersonService personService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	delete(String username, String groupName)	Remove the given User identified by username from the given Group identified by groupName.
javax.ws.rs.core.Response	update(String username, String groupName)	Add the given User identified by username to the given Group identified by groupName.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGroupResource

public UserGroupResource(PersonService personService)

Method Detail

update

public javax.ws.rs.core.Response update(String username,
                                        String groupName)

Add the given User identified by username to the given Group identified by groupName. This method is idempotent i.e. if the membership already exists then no action will be taken.

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.

delete

public javax.ws.rs.core.Response delete(String username,
                                        String groupName)

Remove the given User identified by username from the given Group identified by groupName. This method is idempotent i.e. if the membership is not present then no action will be taken.

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.