UsersResource (Atlassian Crowd 4.4.0 API)

java.lang.Object
- com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
- - com.atlassian.crowd.plugin.rest.service.resource.usermanagement.UsersResource

@Path(value="user")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public class UsersResource
extends AbstractResource

Field Summary
- Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
  request, uriInfo

Constructor Summary

Constructors
Constructor and Description

UsersResource(UsersController usersController)

Constructors
Constructor and Description
`UsersResource(UsersController usersController)`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getUserByOpenid(URI openId)` Looks up a user by the v2 OpenID URL, and returns the user's details
`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.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource
getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersResource

public UsersResource(UsersController usersController)

Method Detail

getUser

@GET
public javax.ws.rs.core.Response getUser(@QueryParam(value="username")
                                              String userName,
                                              @QueryParam(value="key")
                                              String key)
                                       throws UserNotFoundException

Retrieves the user details. Either username or key query parameter must be present.

The 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 response

Parameters:: userName - name of the user; key - the key of the user (only observed if userName is null).
Throws:: UserNotFoundException

getUserByOpenid

@ExperimentalApi
 @GET
 @Path(value="id")
public javax.ws.rs.core.Response getUserByOpenid(@QueryParam(value="openid")
                                                                                           URI openId)
                                                                                    throws UserNotFoundException

Looks up a user by the v2 OpenID URL, and returns the user's details

Parameters:: openId - the v2 OpenID URL for the user
Throws:: UserNotFoundException

addUser

@POST
public javax.ws.rs.core.Response addUser(UserEntity userEntity)
                                        throws InvalidUserException,
                                               InvalidCredentialException,
                                               UserNotFoundException,
                                               ApplicationPermissionException,
                                               OperationFailedException,
                                               UserAlreadyExistsException

Creates a new user

Throws:: InvalidUserException; InvalidCredentialException; UserNotFoundException; ApplicationPermissionException; OperationFailedException; UserAlreadyExistsException

updateUser

@PUT
public javax.ws.rs.core.Response updateUser(@QueryParam(value="username")
                                                 String userName,
                                                 UserEntity userEntity)
                                          throws InvalidUserException,
                                                 UserNotFoundException,
                                                 ApplicationPermissionException,
                                                 OperationFailedException

Updates a user.

Parameters:: userName - name of the user to update
Throws:: InvalidUserException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

removeUser

@DELETE
public javax.ws.rs.core.Response removeUser(@QueryParam(value="username")
                                                    String userName)
                                             throws UserNotFoundException,
                                                    ApplicationPermissionException,
                                                    OperationFailedException

Removes a user.

Parameters:: userName - name of the user to remove
Throws:: UserNotFoundException; ApplicationPermissionException; OperationFailedException

renameUser

@POST
 @Path(value="rename")
public javax.ws.rs.core.Response renameUser(@QueryParam(value="username")
                                                                         String userName,
                                                                         RenameEntity newUserName)
                                                                  throws InvalidUserException,
                                                                         UserNotFoundException,
                                                                         ApplicationPermissionException,
                                                                         OperationFailedException

Renames a user.

Parameters:: userName - name of the user to rename
Throws:: InvalidUserException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

getUserAttributes

@GET
 @Path(value="attribute")
public javax.ws.rs.core.Response getUserAttributes(@QueryParam(value="username")
                                                                                  String userName)
                                                                           throws UserNotFoundException

Retrieves a list of user attributes

Parameters:: userName - name of the user
Throws:: UserNotFoundException

storeUserAttributes

@POST
 @Path(value="attribute")
public javax.ws.rs.core.Response storeUserAttributes(@QueryParam(value="username")
                                                                                     String userName,
                                                                                     MultiValuedAttributeEntityList attributes)
                                                                              throws UserNotFoundException,
                                                                                     ApplicationPermissionException,
                                                                                     OperationFailedException

Stores the user attributes. Attribute values will not be overwritten if not specified in attributes.

Parameters:: userName - name of the user
Throws:: UserNotFoundException; ApplicationPermissionException; OperationFailedException

removeUserAttribute

@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

Deletes a user attribute.

Parameters:: userName - name of the user; attributeName - name of the attribute to delete
Throws:: UserNotFoundException; ApplicationPermissionException; OperationFailedException

updateUserPassword

@PUT
 @Path(value="password")
public javax.ws.rs.core.Response updateUserPassword(@QueryParam(value="username")
                                                                                  String userName,
                                                                                  PasswordEntity password)
                                                                           throws InvalidCredentialException,
                                                                                  UserNotFoundException,
                                                                                  ApplicationPermissionException,
                                                                                  OperationFailedException

Updates a user password.

Parameters:: userName - the name of the user to update the password for
Throws:: InvalidCredentialException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

deleteUserPassword

@DELETE
 @Path(value="password")
public javax.ws.rs.core.Response deleteUserPassword(@QueryParam(value="username")
                                                                                     String userName)
                                                                              throws InvalidCredentialException,
                                                                                     UserNotFoundException,
                                                                                     ApplicationPermissionException,
                                                                                     OperationFailedException

Deletes a user password. This will prevent the user from logging in using a password.

Parameters:: userName - the name of the user to update the password for
Throws:: InvalidCredentialException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

requestPasswordReset

@POST
 @Path(value="mail/password")
public javax.ws.rs.core.Response requestPasswordReset(@QueryParam(value="username")
                                                                                          String userName)
                                                                                   throws InvalidEmailAddressException,
                                                                                          UserNotFoundException,
                                                                                          ApplicationPermissionException,
                                                                                          OperationFailedException

Sends the user a password reset link to the user's email address

Parameters:: userName - name of the user to request a password reset
Throws:: InvalidEmailAddressException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

expireAllPasswords

@ExperimentalApi
 @POST
 @Path(value="expire-all-passwords")
public javax.ws.rs.core.Response expireAllPasswords(@QueryParam(value="confirm")
                                                                                                                 boolean confirm)
                                                                                                          throws OperationFailedException

Expires all passwords for all directories which are part of this application, regardless of group mapping.

Parameters:: confirm - must be true to take the action. This is so all passwords cannot accidentally be expired.
Throws:: OperationFailedException

requestUsernamesReminder

@POST
 @Path(value="mail/usernames")
public javax.ws.rs.core.Response requestUsernamesReminder(@QueryParam(value="email")
                                                                                               String email)
                                                                                        throws InvalidEmailAddressException

Requests an email to be sent containing usernames associated with the given email address.

Parameters:: email - email address of the user
Throws:: InvalidEmailAddressException

getDirectGroups

@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

Returns the a list of groups the user is a direct member of.

Parameters:: userName - name of the user; groupName - 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 return; startIndex - start index of the result
Throws:: MembershipNotFoundException; UserNotFoundException

addUserToGroup

@POST
 @Path(value="group/direct")
public javax.ws.rs.core.Response addUserToGroup(@QueryParam(value="username")
                                                                                   String userName,
                                                                                   GroupEntity parentGroup)
                                                                            throws UserNotFoundException,
                                                                                   ApplicationPermissionException,
                                                                                   OperationFailedException,
                                                                                   MembershipAlreadyExistsException

Adds a user as a direct member of the group

Parameters:: userName - name of the user; parentGroup - parent group entity
Throws:: UserNotFoundException; ApplicationPermissionException; OperationFailedException; MembershipAlreadyExistsException

removeUserFromGroup

@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

Removes a user from a group.

Parameters:: userName - name of the user; groupName - name of the group
Throws:: GroupNotFoundException; MembershipNotFoundException; UserNotFoundException; ApplicationPermissionException; OperationFailedException

getNestedGroups

@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

Retrieves the group that the user is a nested member of

Parameters:: userName - name of the user; groupName - 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 return; startIndex - start index of the result
Throws:: MembershipNotFoundException; UserNotFoundException

getAvatarForUser

@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

Returns the url of the user's avatar

Parameters:: username - the name of the user; size - the requested avatar size in pixels
Throws:: UserNotFoundException; DirectoryNotFoundException; OperationFailedException

Class UsersResource

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

Constructor Summary