com.atlassian.confluence.user.extras.rest

Class UsersResource

java.lang.Object

com.atlassian.confluence.user.extras.rest.UsersResource

public class UsersResource
extends Object

This provides rest URLs to get Admin only user data from the system.

Constructor Summary

Constructors

Constructor and Description
UsersResource(UsersEntityBuilder usersEntityBuilder, PermissionManager permissionManager, UserAccessor userAccessor)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createUser(UserCreateRequestEntity request)
javax.ws.rs.core.Response	createUsers(String usernamesStr, String emailDomain) Accepts comma-separated usernames and creates users for them, with each user's email address the username plus '@' and the domain name.
javax.ws.rs.core.Response	getUsers(int startIndex, int maxResults)

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersResource

public UsersResource(UsersEntityBuilder usersEntityBuilder,
                     PermissionManager permissionManager,
                     UserAccessor userAccessor)

Method Detail

getUsers

public javax.ws.rs.core.Response getUsers(int startIndex,
                                          int maxResults)

createUser

public javax.ws.rs.core.Response createUser(UserCreateRequestEntity request)

createUsers

public javax.ws.rs.core.Response createUsers(String usernamesStr,
                                             String emailDomain)

Accepts comma-separated usernames and creates users for them, with each user's email address the username plus '@' and the domain name.

Parameters:

usernamesStr - a comma-separated list of usernames to create

emailDomain - the domain name for the email-address to create for each user

Returns:

a map with 'created' and 'failed' usernames