@Path(value="user") @Consumes(value={"application/xml","application/json"}) @Produces(value={"application/xml","application/json"}) public class UsersResource extends AbstractResource
request, uriInfo
Constructor and Description |
---|
UsersResource(UsersController usersController) |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addUser(UserEntity userEntity)
Creates a new user
|
javax.ws.rs.core.Response |
addUserToGroup(String userName,
GroupEntity parentGroup)
Adds a user as a direct member of the group
|
javax.ws.rs.core.Response |
deleteUserPassword(String userName)
Deletes a user password.
|
javax.ws.rs.core.Response |
expireAllPasswords(boolean confirm)
Expires all passwords for all directories which are part of this application, regardless of
group mapping.
|
javax.ws.rs.core.Response |
getAvatarForUser(String username,
int size)
Returns the url of the user's avatar
|
javax.ws.rs.core.Response |
getDirectGroups(String userName,
String groupName,
int maxResults,
int startIndex)
Returns the a list of groups the user is a direct member of.
|
javax.ws.rs.core.Response |
getNestedGroups(String userName,
String groupName,
int maxResults,
int startIndex)
Retrieves the group that the user is a nested member of
|
javax.ws.rs.core.Response |
getUser(String userName,
String key)
Retrieves the user details.
|
javax.ws.rs.core.Response |
getUserAttributes(String userName)
Retrieves a list of user attributes
|
javax.ws.rs.core.Response |
removeUser(String userName)
Removes a user.
|
javax.ws.rs.core.Response |
removeUserAttribute(String userName,
String attributeName)
Deletes a user attribute.
|
javax.ws.rs.core.Response |
removeUserFromGroup(String userName,
String groupName)
Removes a user from a group.
|
javax.ws.rs.core.Response |
renameUser(String userName,
RenameEntity newUserName)
Renames a user.
|
javax.ws.rs.core.Response |
requestPasswordReset(String userName)
Sends the user a password reset link to the user's email address
|
javax.ws.rs.core.Response |
requestUsernamesReminder(String email)
Requests an email to be sent containing usernames associated with the given email address.
|
javax.ws.rs.core.Response |
storeUserAttributes(String userName,
MultiValuedAttributeEntityList attributes)
Stores the user attributes.
|
javax.ws.rs.core.Response |
updateUser(String userName,
UserEntity userEntity)
Updates a user.
|
javax.ws.rs.core.Response |
updateUserPassword(String userName,
PasswordEntity password)
Updates a user password.
|
getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo
@Inject public UsersResource(UsersController usersController)
@GET public javax.ws.rs.core.Response getUser(@QueryParam(value="username") String userName, @QueryParam(value="key") String key) throws UserNotFoundException
expand
parameter can be used to include additional data in the response.
This can currently be set to attributes
, to include the user's attributes in the responseuserName
- name of the userkey
- the key of the user (only observed if userName is null).UserNotFoundException
@POST public javax.ws.rs.core.Response addUser(UserEntity userEntity) throws InvalidUserException, InvalidCredentialException, UserNotFoundException, ApplicationPermissionException, OperationFailedException, UserAlreadyExistsException
@PUT public javax.ws.rs.core.Response updateUser(@QueryParam(value="username") String userName, UserEntity userEntity) throws InvalidUserException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to updateInvalidUserException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@DELETE public javax.ws.rs.core.Response removeUser(@QueryParam(value="username") String userName) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to removeUserNotFoundException
ApplicationPermissionException
OperationFailedException
@POST @Path(value="rename") public javax.ws.rs.core.Response renameUser(@QueryParam(value="username") String userName, RenameEntity newUserName) throws InvalidUserException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to renameInvalidUserException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@GET @Path(value="attribute") public javax.ws.rs.core.Response getUserAttributes(@QueryParam(value="username") String userName) throws UserNotFoundException
userName
- name of the userUserNotFoundException
@POST @Path(value="attribute") public javax.ws.rs.core.Response storeUserAttributes(@QueryParam(value="username") String userName, MultiValuedAttributeEntityList attributes) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the userUserNotFoundException
ApplicationPermissionException
OperationFailedException
@DELETE @Path(value="attribute") public javax.ws.rs.core.Response removeUserAttribute(@QueryParam(value="username") String userName, @QueryParam(value="attributename") String attributeName) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the userattributeName
- name of the attribute to deleteUserNotFoundException
ApplicationPermissionException
OperationFailedException
@PUT @Path(value="password") public javax.ws.rs.core.Response updateUserPassword(@QueryParam(value="username") String userName, PasswordEntity password) throws InvalidCredentialException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- the name of the user to update the password forInvalidCredentialException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@DELETE @Path(value="password") public javax.ws.rs.core.Response deleteUserPassword(@QueryParam(value="username") String userName) throws InvalidCredentialException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- the name of the user to update the password forInvalidCredentialException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@POST @Path(value="mail/password") public javax.ws.rs.core.Response requestPasswordReset(@QueryParam(value="username") String userName) throws InvalidEmailAddressException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the user to request a password resetInvalidEmailAddressException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@ExperimentalApi @POST @Path(value="expire-all-passwords") public javax.ws.rs.core.Response expireAllPasswords(@QueryParam(value="confirm") boolean confirm) throws OperationFailedException
confirm
- must be true to take the action. This is so all passwords cannot
accidentally be expired.OperationFailedException
@POST @Path(value="mail/usernames") public javax.ws.rs.core.Response requestUsernamesReminder(@QueryParam(value="email") String email) throws InvalidEmailAddressException
email
- email address of the userInvalidEmailAddressException
@GET @Path(value="group/direct") public javax.ws.rs.core.Response getDirectGroups(@QueryParam(value="username") String userName, @QueryParam(value="groupname") String groupName, @DefaultValue(value="1000") @QueryParam(value="max-results") int maxResults, @DefaultValue(value="0") @QueryParam(value="start-index") int startIndex) throws MembershipNotFoundException, UserNotFoundException
userName
- name of the usergroupName
- name of the group (optional). If null, then all the groups that the user is a direct member of, are returned.maxResults
- maximum number of results to returnstartIndex
- start index of the resultMembershipNotFoundException
UserNotFoundException
@POST @Path(value="group/direct") public javax.ws.rs.core.Response addUserToGroup(@QueryParam(value="username") String userName, GroupEntity parentGroup) throws UserNotFoundException, ApplicationPermissionException, OperationFailedException, MembershipAlreadyExistsException
userName
- name of the userparentGroup
- parent group entityUserNotFoundException
ApplicationPermissionException
OperationFailedException
MembershipAlreadyExistsException
@DELETE @Path(value="group/direct") public javax.ws.rs.core.Response removeUserFromGroup(@QueryParam(value="username") String userName, @QueryParam(value="groupname") String groupName) throws GroupNotFoundException, MembershipNotFoundException, UserNotFoundException, ApplicationPermissionException, OperationFailedException
userName
- name of the usergroupName
- name of the groupGroupNotFoundException
MembershipNotFoundException
UserNotFoundException
ApplicationPermissionException
OperationFailedException
@GET @Path(value="group/nested") public javax.ws.rs.core.Response getNestedGroups(@QueryParam(value="username") String userName, @QueryParam(value="groupname") String groupName, @DefaultValue(value="1000") @QueryParam(value="max-results") int maxResults, @DefaultValue(value="0") @QueryParam(value="start-index") int startIndex) throws MembershipNotFoundException, UserNotFoundException
userName
- name of the usergroupName
- name of the group (optional). If null, then all the groups that the user is a nested member of, are returned.maxResults
- maximum number of results to returnstartIndex
- start index of the resultMembershipNotFoundException
UserNotFoundException
@ExperimentalApi @GET @Path(value="avatar") public javax.ws.rs.core.Response getAvatarForUser(@QueryParam(value="username") String username, @QueryParam(value="s") @DefaultValue(value="128") int size) throws UserNotFoundException, DirectoryNotFoundException, OperationFailedException
username
- the name of the usersize
- the requested avatar size in pixelsUserNotFoundException
DirectoryNotFoundException
OperationFailedException
Copyright © 2024 Atlassian. All rights reserved.