Rest Users » History » Version 23
Go MAEDA, 2017-12-17 06:48
Typo: s/coma/comma/
1 | 1 | Jean-Philippe Lang | h1. Users |
---|---|---|---|
2 | |||
3 | 3 | Jean-Philippe Lang | {{>toc}} |
4 | |||
5 | 7 | Jean-Philippe Lang | h2. /users.:format |
6 | 1 | Jean-Philippe Lang | |
7 | 7 | Jean-Philippe Lang | h3. GET |
8 | |||
9 | Returns a list of users. |
||
10 | |||
11 | 20 | Cyril Jouve | This endpoint requires admin privileges. |
12 | |||
13 | 7 | Jean-Philippe Lang | +Example+: |
14 | |||
15 | 1 | Jean-Philippe Lang | GET /users.xml |
16 | |||
17 | 10 | Jean-Baptiste Barth | Optional filters: |
18 | |||
19 | 13 | Go MAEDA | * @status@: get only users with the given status. See "app/models/principal.rb":/projects/redmine/repository/entry/trunk/app/models/principal.rb#L22-25 for a list of available statuses. Default is @1@ (active users). Possible values are: |
20 | ** @1@: Active (User can login and use their account) |
||
21 | ** @2@: Registered (User has registered but not yet confirmed their email address or was not yet activated by an administrator. User can not login) |
||
22 | ** @3@: Locked (User was once active and is now locked, User can not login) |
||
23 | 10 | Jean-Baptiste Barth | * @name@: filter users on their login, firstname, lastname and mail ; if the pattern contains a space, it will also return users whose firstname match the first word or lastname match the second word. |
24 | * @group_id@: get only users who are members of the given group |
||
25 | |||
26 | 7 | Jean-Philippe Lang | h3. POST |
27 | 1 | Jean-Philippe Lang | |
28 | 7 | Jean-Philippe Lang | Creates a user. |
29 | 1 | Jean-Philippe Lang | |
30 | 20 | Cyril Jouve | This endpoint requires admin privileges. |
31 | |||
32 | 7 | Jean-Philippe Lang | +Parameters+: |
33 | 1 | Jean-Philippe Lang | |
34 | 7 | Jean-Philippe Lang | * @user@ (required): a hash of the user attributes, including: |
35 | 1 | Jean-Philippe Lang | |
36 | 7 | Jean-Philippe Lang | * @login@ (required): the user login |
37 | * @password@: the user password |
||
38 | * @firstname@ (required) |
||
39 | * @lastname@ (required) |
||
40 | * @mail@ (required) |
||
41 | * @auth_source_id@: authentication mode id |
||
42 | 12 | Matt Wiseley | * @mail_notification@: only_my_events, none, etc. |
43 | * @must_change_passwd@: true or false |
||
44 | 19 | F. P. | * @generate_password@: true or false |
45 | * @send_information@: true or false : Send acocunt information to the user |
||
46 | |||
47 | 1 | Jean-Philippe Lang | |
48 | 7 | Jean-Philippe Lang | +Example+: |
49 | 1 | Jean-Philippe Lang | |
50 | 17 | Toshi MARUYAMA | <pre> |
51 | 7 | Jean-Philippe Lang | POST /users.xml |
52 | 17 | Toshi MARUYAMA | </pre> |
53 | 1 | Jean-Philippe Lang | |
54 | 16 | Toshi MARUYAMA | <pre><code class="xml"> |
55 | 7 | Jean-Philippe Lang | <?xml version="1.0" encoding="ISO-8859-1" ?> |
56 | <user> |
||
57 | <login>jplang</login> |
||
58 | <firstname>Jean-Philippe</firstname> |
||
59 | <lastname>Lang</lastname> |
||
60 | <password>secret</password> |
||
61 | <mail>jp_lang@yahoo.fr</mail> |
||
62 | <auth_source_id>2</auth_source_id> |
||
63 | </user> |
||
64 | 16 | Toshi MARUYAMA | </code></pre> |
65 | 7 | Jean-Philippe Lang | |
66 | 8 | Lutz Horn | JSON |
67 | |||
68 | 16 | Toshi MARUYAMA | <pre><code class="json"> |
69 | 8 | Lutz Horn | { |
70 | "user": { |
||
71 | "login": "jplang", |
||
72 | "firstname": "Jean-Philippe", |
||
73 | "lastname": "Lang", |
||
74 | "mail": "jp_lang@yahoo.fr", |
||
75 | "password": "secret" |
||
76 | } |
||
77 | } |
||
78 | 16 | Toshi MARUYAMA | </code></pre> |
79 | 8 | Lutz Horn | |
80 | 7 | Jean-Philippe Lang | +Response+: |
81 | |||
82 | * @201 Created@: user was created |
||
83 | * @422 Unprocessable Entity@: user was not created due to validation failures (response body contains the error messages) |
||
84 | |||
85 | h2. /users/:id.:format |
||
86 | |||
87 | h3. GET |
||
88 | |||
89 | Returns the user details. You can use @/users/current.:format@ for retrieving the user whose credentials are used to access the API. |
||
90 | |||
91 | 21 | Cyril Jouve | This endpoint can be used by admin or non admin but the returned fields will depend on the privileges of the requesting user (see Response below). |
92 | 20 | Cyril Jouve | |
93 | 3 | Jean-Philippe Lang | +Parameters+: |
94 | 1 | Jean-Philippe Lang | |
95 | 23 | Go MAEDA | * @include@ (optional): a comma separated list of associations to include in the response: |
96 | 1 | Jean-Philippe Lang | |
97 | 11 | Jean-Baptiste Barth | * @memberships@ : adds extra information about user's memberships and roles on the projects |
98 | * @groups@ (added in 2.1) : adds extra information about user's groups |
||
99 | 1 | Jean-Philippe Lang | |
100 | 7 | Jean-Philippe Lang | +Examples+: |
101 | 1 | Jean-Philippe Lang | |
102 | 7 | Jean-Philippe Lang | GET /users/current.xml |
103 | |||
104 | Returns the details about the current user. |
||
105 | |||
106 | 1 | Jean-Philippe Lang | GET /users/3.xml?include=memberships,groups |
107 | |||
108 | Returns the details about user ID 3, and additional detail about the user's project memberships. |
||
109 | |||
110 | 18 | Toshi MARUYAMA | +Response+: |
111 | 1 | Jean-Philippe Lang | |
112 | 18 | Toshi MARUYAMA | <pre><code class="xml"> |
113 | 1 | Jean-Philippe Lang | <user> |
114 | <id>3</id> |
||
115 | <login>jplang</login> |
||
116 | <firstname>Jean-Philippe</firstname> |
||
117 | <lastname>Lang</lastname> |
||
118 | <mail>jp_lang@yahoo.fr</mail> |
||
119 | <created_on>2007-09-28T00:16:04+02:00</created_on> |
||
120 | <last_login_on>2011-08-01T18:05:45+02:00</last_login_on> |
||
121 | 14 | Go MAEDA | <api_key>ebc3f6b781a6fb3f2b0a83ce0ebb80e0d585189d</api_key> |
122 | <status>1</status> |
||
123 | 5 | Rick Mason | <custom_fields type="array" /> |
124 | 1 | Jean-Philippe Lang | <memberships type="array"> |
125 | 4 | Jean-Philippe Lang | <membership> |
126 | <project name="Redmine" id="1"/> |
||
127 | <roles type="array"> |
||
128 | <role name="Administrator" id="3"/> |
||
129 | <role name="Contributor" id="4"/> |
||
130 | 1 | Jean-Philippe Lang | </roles> |
131 | </membership> |
||
132 | </memberships> |
||
133 | <groups type="array"> |
||
134 | <group id="20" name="Developers"/> |
||
135 | </groups> |
||
136 | </user> |
||
137 | </code></pre> |
||
138 | 4 | Jean-Philippe Lang | |
139 | 21 | Cyril Jouve | If the user doing the request is not admin, it depends on the requested user: |
140 | |||
141 | 22 | Cyril Jouve | * if the user is not locked and is not admin, the endpoint returns a user object with the fields @firstname@, @lastname@, @mail@, @created_on@ |
142 | * if the user is not locked and is admin, the endpoint returns a user object with the fields @firstname@, @lastname@, @created_on@, @last_login_on@ |
||
143 | 21 | Cyril Jouve | * if the user is locked, the endpoint returns 404 status code |
144 | 22 | Cyril Jouve | * if the user is the requesting user, you will also have the fields @login@, @api_key@ |
145 | 21 | Cyril Jouve | |
146 | If the user doing the request is admin, a user object is always returned (blocked or not). It will have some more details: |
||
147 | 9 | Jean-Baptiste Barth | * @api_key@ : the API key of the user, visible for admins and for yourself (added in 2.3.0) |
148 | * @status@ : a numeric id representing the status of the user, visible for admins only (added in 2.4.0). See "app/models/principal.rb":/projects/redmine/repository/entry/trunk/app/models/principal.rb#L22-25 for a list of available statuses. |
||
149 | |||
150 | 7 | Jean-Philippe Lang | h3. PUT |
151 | 4 | Jean-Philippe Lang | |
152 | 7 | Jean-Philippe Lang | Updates a user. |
153 | 4 | Jean-Philippe Lang | |
154 | 20 | Cyril Jouve | This endpoint requires admin privileges. |
155 | |||
156 | 1 | Jean-Philippe Lang | +Example+: |
157 | |||
158 | 7 | Jean-Philippe Lang | PUT /users/20.xml |
159 | 1 | Jean-Philippe Lang | |
160 | +Parameters+: |
||
161 | |||
162 | * @user@ (required): a hash of the user attributes (same as for user creation) |
||
163 | |||
164 | 7 | Jean-Philippe Lang | h3. DELETE |
165 | 20 | Cyril Jouve | |
166 | This endpoint requires admin privileges. |
||
167 | 1 | Jean-Philippe Lang | |
168 | 7 | Jean-Philippe Lang | Deletes a user. |
169 | 4 | Jean-Philippe Lang | |
170 | 7 | Jean-Philippe Lang | +Example+: |
171 | 1 | Jean-Philippe Lang | |
172 | 7 | Jean-Philippe Lang | DELETE /users/20.xml |
173 | 1 | Jean-Philippe Lang | |
174 | +Response+: |
||
175 | 4 | Jean-Philippe Lang | |
176 | * @200 OK@: user was deleted |
||
177 | 7 | Jean-Philippe Lang | |
178 | h2. See also |
||
179 | |||
180 | * The [[Rest_Memberships|Memberships API]] for adding or removing a user from a project. |
||
181 | * The [[Rest_Groups|Groups API]] for adding or removing a user from a group. |