com.atlassian.bamboo.plugins.rest.user

Class UserAdminResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.user.UserAdminResource

public class UserAdminResource
extends Object

REST resource to manage users in Bamboo.

Since:

6.6

Constructor Summary

Constructors

Constructor and Description

UserAdminResource(BambooAuthenticationContext bambooAuthenticationContext, BambooPermissionManager bambooPermissionManager, BambooUserManager bambooUserManager, com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService, com.atlassian.crowd.embedded.api.CrowdService crowdService, GravatarService gravatarService, PaginationService paginationService, RestUserAccessTokenService restUserAccessTokenService, com.atlassian.struts.TextProvider textProvider, com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate, UserRenameService userRenameService, ExtendedAuthorManager extendedAuthorManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	assignGroups(String userName, List<String> groupsToAssign) Add a user to multiple groups.
javax.ws.rs.core.Response	changeUserPassword(RestUserPasswordUpdate passwordChangeRequest) Change password of specified user The authenticated user must have restricted administrative permission or higher to use this resource.
javax.ws.rs.core.Response	createUser(RestNewUser newUser) Create a new user.
javax.ws.rs.core.Response	createUserRepositoryAlias(String userName, List<String> userAliases) Link existing unlined alias or create the new one.
javax.ws.rs.core.Response	deleteUser(String userName) Deletes the specified user, removing them from the system.
RestPageModel<RestGroup>	findAssignedGroups(String userName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieves a list of groups to which the user belongs.
RestPageModel<RestGroup>	findUnassignedGroups(String userName, String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieves a list of groups to which the user does not belong.
RestPageModel<RestUserAlias>	findUnassignedUserRepositoryAliases(String filter, String userName, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieves a list of unlinked aliases to which the user does not belong.
RestPageModel<RestAccessToken>	getUserAccessTokens(String userName, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a page of user's access tokens.
RestPageModel<RestUserAlias>	getUserRepositoryAliases(String userName, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a page of aliases.
RestPageModel<RestUserDetails>	getUsers(String filter, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Retrieve a page of users.
javax.ws.rs.core.Response	renameUser(RestUserRenameRequest userRenameRequest) Renames specified user The authenticated user must have restricted administrative permission or higher to use this resource.
javax.ws.rs.core.Response	revokeUserToken(String userName, String tokenId) Revoke user's access token.
javax.ws.rs.core.Response	unassignGroups(String userName, List<String> groupsToRemove) Remove a user from multiple groups.
javax.ws.rs.core.Response	unlinkUserRepositoryAlias(String userName, RestUserAlias alias) Unlink the specified alias from user, removing them from the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAdminResource

@Inject
public UserAdminResource(BambooAuthenticationContext bambooAuthenticationContext,
                                 BambooPermissionManager bambooPermissionManager,
                                 BambooUserManager bambooUserManager,
                                 com.atlassian.crowd.embedded.api.CrowdDirectoryService crowdDirectoryService,
                                 com.atlassian.crowd.embedded.api.CrowdService crowdService,
                                 GravatarService gravatarService,
                                 PaginationService paginationService,
                                 RestUserAccessTokenService restUserAccessTokenService,
                                 com.atlassian.struts.TextProvider textProvider,
                                 com.atlassian.sal.api.transaction.TransactionTemplate transactionTemplate,
                                 UserRenameService userRenameService,
                                 ExtendedAuthorManager extendedAuthorManager)

Method Detail

getUsers

public RestPageModel<RestUserDetails> getUsers(String filter,
                                               @Context
                                               PageRequest pageRequest,
                                               @Context
                                               Expansion expansion,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)

Retrieve a page of users. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

filter - If specified only users, whose username, full name or email contain the supplied string (case insensitive) will be returned.

createUser

public javax.ws.rs.core.Response createUser(@RequestBody
                                            RestNewUser newUser)
                                     throws WebValidationException

Create a new user. The authenticated user must have restricted administrative permission or higher to use this resource.

Throws:

WebValidationException

deleteUser

public javax.ws.rs.core.Response deleteUser(String userName)
                                     throws WebValidationException

Deletes the specified user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user to delete.

Throws:

WebValidationException

renameUser

public javax.ws.rs.core.Response renameUser(@RequestBody
                                            RestUserRenameRequest userRenameRequest)
                                     throws UserRenameException,
                                            WebValidationException

Renames specified user The authenticated user must have restricted administrative permission or higher to use this resource.

Throws:

UserRenameException

WebValidationException

changeUserPassword

public javax.ws.rs.core.Response changeUserPassword(@RequestBody
                                                    RestUserPasswordUpdate passwordChangeRequest)
                                             throws WebValidationException,
                                                    com.atlassian.user.EntityException

Change password of specified user The authenticated user must have restricted administrative permission or higher to use this resource.

Throws:

WebValidationException

com.atlassian.user.EntityException

assignGroups

public javax.ws.rs.core.Response assignGroups(String userName,
                                              @RequestBody
                                              List<String> groupsToAssign)
                                       throws WebValidationException

Add a user to multiple groups. The list of groups should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user.

Throws:

WebValidationException

unassignGroups

public javax.ws.rs.core.Response unassignGroups(String userName,
                                                @RequestBody
                                                List<String> groupsToRemove)
                                         throws WebValidationException

Remove a user from multiple groups. The list of groups should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user.

Throws:

WebValidationException

findAssignedGroups

public RestPageModel<RestGroup> findAssignedGroups(String userName,
                                                   String filter,
                                                   @Context
                                                   PageRequest pageRequest,
                                                   @Context
                                                   Expansion expansion,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)

Retrieves a list of groups to which the user belongs. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user.

filter - If specified, only groups with names containing the supplied string will be returned.

findUnassignedGroups

public RestPageModel<RestGroup> findUnassignedGroups(String userName,
                                                     String filter,
                                                     @Context
                                                     PageRequest pageRequest,
                                                     @Context
                                                     Expansion expansion,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uriInfo)
                                              throws com.atlassian.user.EntityException

Retrieves a list of groups to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user.

filter - If specified, only groups with names containing the supplied string will be returned.

Throws:

com.atlassian.user.EntityException

findUnassignedUserRepositoryAliases

public RestPageModel<RestUserAlias> findUnassignedUserRepositoryAliases(String filter,
                                                                        String userName,
                                                                        @Context
                                                                        PageRequest pageRequest,
                                                                        @Context
                                                                        Expansion expansion,
                                                                        @Context
                                                                        javax.ws.rs.core.UriInfo uriInfo)

Retrieves a list of unlinked aliases to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user.

filter - If specified, only aliases with names containing the supplied string will be returned.

getUserRepositoryAliases

public RestPageModel<RestUserAlias> getUserRepositoryAliases(String userName,
                                                             @Context
                                                             PageRequest pageRequest,
                                                             @Context
                                                             Expansion expansion,
                                                             @Context
                                                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve a page of aliases. The authenticated user must have restricted administrative permission or higher to use this resource.

createUserRepositoryAlias

public javax.ws.rs.core.Response createUserRepositoryAlias(String userName,
                                                           @RequestBody
                                                           List<String> userAliases)

Link existing unlined alias or create the new one. The authenticated user must have restricted administrative permission or higher to use this resource.

unlinkUserRepositoryAlias

public javax.ws.rs.core.Response unlinkUserRepositoryAlias(String userName,
                                                           @RequestBody
                                                           RestUserAlias alias)

Unlink the specified alias from user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user to delete.

alias - alias to unlink

getUserAccessTokens

public RestPageModel<RestAccessToken> getUserAccessTokens(String userName,
                                                          @Context
                                                          PageRequest pageRequest,
                                                          @Context
                                                          Expansion expansion,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)

Retrieve a page of user's access tokens. The authenticated user must have restricted administrative permission or higher to use this resource.

revokeUserToken

public javax.ws.rs.core.Response revokeUserToken(String userName,
                                                 String tokenId)
                                          throws WebValidationException

Revoke user's access token. The authenticated user must have restricted administrative permission or higher to use this resource.

Parameters:

userName - The name identifying the user to revoke access token from.

tokenId - id of token

Throws:

WebValidationException