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

Class AdminUserResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.resources.AdminUserResource

public final class AdminUserResource
extends Object

REST API for User management actions that require elevated privileges.

Since:

8.2.0

Constructor Summary

Constructors

Constructor	Description
AdminUserResource(PersonService personService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	delete(String username)	Delete the given User identified by username.
javax.ws.rs.core.Response	disable(String username)	Disable the given User identified by username.
javax.ws.rs.core.Response	enable(String username)	Enable the given User identified by username.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminUserResource

public AdminUserResource(PersonService personService)

Method Detail

disable

public javax.ws.rs.core.Response disable(String username)

Disable the given User identified by username. This method is idempotent i.e. if the user is already disabled then no action will be taken.

Parameters:

username - The username identifying the given user.

enable

public javax.ws.rs.core.Response enable(String username)

Enable the given User identified by username. This method is idempotent i.e. if the user is already enabled then no action will be taken.

Parameters:

username - The username identifying the given user.

delete

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

Delete the given User identified by username. This action is processed asynchronously.

Parameters:

username - The username identifying the given user.