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 Description UsersResource(UsersEntityBuilder usersEntityBuilder, PermissionManager permissionManager, UserAccessor userAccessor, SpaceManager spaceManager)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(String query, String spaceKey, int start, int limit)
This end point will search and return a paginated list of users based on the query provided.
-
-
-
Constructor Detail
-
UsersResource
public UsersResource(UsersEntityBuilder usersEntityBuilder, PermissionManager permissionManager, UserAccessor userAccessor, SpaceManager spaceManager)
-
-
Method Detail
-
getUsers
public javax.ws.rs.core.Response getUsers(String query, String spaceKey, int start, int limit)
This end point will search and return a paginated list of users based on the query provided. If the current user is not authenticated or does not have the permission to execute, an 401 UNAUTHORIZED response will be returned.- Parameters:
query
- the query string. It may contain the asterisk wildcardsspaceKey
- the space key if the space admin is searching in a spacestart
- the start indexlimit
- the limit of the result- Returns:
- a list of users within the limit.
-
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 createemailDomain
- the domain name for the email-address to create for each user- Returns:
- a map with 'created' and 'failed' usernames
-
-