Rest Users » History » Revision 3
Revision 2 (Bevan Rudge, 2011-07-05 01:11) → Revision 3/30 (Jean-Philippe Lang, 2011-08-01 18:23)
h1. Users {{>toc}} h2. Listing users GET /users.xml Returns users. h2. Showing a user GET /users/[id].xml Returns the user of given id. GET /users/current.xml Returns the user whose credentials are used to access the API. +Parameters+: * @include@ (optional): a coma separated list of associations to include in the response: * @memberships@ +Example+: GET /users/3.xml?include=memberships /users/3.json?include=memberships Returns the details about user ID 3, and additional detail about the user's project roles and memberships. +Reponse+: <pre> <user> <id>3</id> <login>jplang</login> <firstname>Jean-Philippe</firstname> <lastname>Lang</lastname> <mail>jp_lang@yahoo.fr</mail> <created_on>2007-09-28T00:16:04+02:00</created_on> <last_login_on>2011-08-01T18:05:45+02:00</last_login_on> <custom_fields type="array" /> <memberships type="array"> <membership> <project name="Redmine" id="1"/> <roles type="array"> <role name="Administrator" id="3"/> <role name="Contributor" id="4"/> </roles> </membership> <membership> </user> </pre> *There are probably other such undocumented features like this*. h2. Creating a user POST /users.xml Creates a user. +Parameters+: * @user@ (required): a hash of the user attributes, including: * @login@ (required): the user login * @password@: the user password * @firstname@ (required) * @lastname@ (required) * @mail@ (required) +Response+: * @201 Created@: user was created * @422 Unprocessable Entity@: user was not created due to validation failures (response body contains the error messages) h2. Updating a user PUT /users/[id].xml +Parameters+: * @user@ (required): a hash of the user attributes Updates the user of given id. h2. Deleting a user Deleting a user is not supported yet.