keystone  18.0.0
About: OpenStack Keystone (Core Service: Identity) provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services.
The "Victoria" series (maintained release).
  Fossies Dox: keystone-18.0.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

groups.inc
Go to the documentation of this file.
1 .. -*- rst -*-
2 
3 ========
4  Groups
5 ========
6 
7 A group is a collection of users. Each group is owned by a domain.
8 
9 You can use groups to ease the task of managing role assignments for users.
10 Assigning a role to a group on a project or domain is equivalent to
11 assigning the role to each group member on that project or domain.
12 
13 When you unassign a role from a group, that role is automatically unassigned
14 from any user that is a member of the group. Any tokens that authenticates those
15 users to the relevant project or domain are revoked.
16 
17 As with users, a group without any role assignments is useless from the
18 perspective of an OpenStack service and has no access to resources.
19 However, a group without role assignments is permitted as a way of
20 acquiring or loading users and groups from external sources before
21 mapping them to projects and domains.
22 
23 
24 List groups
25 ===========
26 
27 .. rest_method:: GET /v3/groups
28 
29 Lists groups.
30 
31 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups``
32 
33 Request
34 -------
35 
36 Parameters
37 ~~~~~~~~~~
38 
39 .. rest_parameters:: parameters.yaml
40 
41  - name: group_name_query
42  - domain_id: domain_id_query
43 
44 Response
45 --------
46 
47 Parameters
48 ~~~~~~~~~~
49 
50 .. rest_parameters:: parameters.yaml
51 
52  - links: link_collection
53  - groups: groups
54  - description: group_description_response_body
55  - domain_id: group_domain_id_response_body
56  - id: group_id_response_body
57  - links: link_response_body
58  - name: group_name_response_body
59 
60 Status Codes
61 ~~~~~~~~~~~~
62 
63 .. rest_status_code:: success status.yaml
64 
65  - 200
66 
67 .. rest_status_code:: error status.yaml
68 
69  - 400
70  - 401
71  - 403
72 
73 Example
74 ~~~~~~~
75 
76 .. literalinclude:: ./samples/admin/groups-list-response.json
77  :language: javascript
78 
79 
80 Create group
81 ============
82 
83 .. rest_method:: POST /v3/groups
84 
85 Creates a group.
86 
87 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/groups``
88 
89 Request
90 -------
91 
92 Parameters
93 ~~~~~~~~~~
94 
95 .. rest_parameters:: parameters.yaml
96 
97  - group: group
98  - description: group_description_request_body
99  - domain_id: group_domain_id_request_body
100  - name: group_name_request_body
101 
102 Example
103 ~~~~~~~
104 
105 .. literalinclude:: ./samples/admin/group-create-request.json
106  :language: javascript
107 
108 Response
109 --------
110 
111 Parameters
112 ~~~~~~~~~~
113 
114 .. rest_parameters:: parameters.yaml
115 
116  - group: group
117  - description: group_description_response_body
118  - domain_id: group_domain_id_response_body
119  - id: group_id_response_body
120  - links: link_response_body
121  - name: group_name_response_body
122 
123 Status Codes
124 ~~~~~~~~~~~~
125 
126 .. rest_status_code:: success status.yaml
127 
128  - 201
129 
130 .. rest_status_code:: error status.yaml
131 
132  - 400
133  - 401
134  - 403
135  - 409
136 
137 Example
138 ~~~~~~~
139 
140 .. literalinclude:: ./samples/admin/group-show-response.json
141  :language: javascript
142 
143 
144 Show group details
145 ==================
146 
147 .. rest_method:: GET /v3/groups/{group_id}
148 
149 Shows details for a group.
150 
151 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group``
152 
153 Request
154 -------
155 
156 Parameters
157 ~~~~~~~~~~
158 
159 .. rest_parameters:: parameters.yaml
160 
161  - group_id: group_id_path
162 
163 Response
164 --------
165 
166 Parameters
167 ~~~~~~~~~~
168 
169 .. rest_parameters:: parameters.yaml
170 
171  - group: group
172  - description: group_description_response_body
173  - domain_id: group_domain_id_response_body
174  - id: group_id_response_body
175  - links: link_response_body
176  - name: group_name_response_body
177 
178 Status Codes
179 ~~~~~~~~~~~~
180 
181 .. rest_status_code:: success status.yaml
182 
183  - 200
184 
185 .. rest_status_code:: error status.yaml
186 
187  - 400
188  - 401
189  - 403
190  - 404
191 
192 Example
193 ~~~~~~~
194 
195 .. literalinclude:: ./samples/admin/group-show-response.json
196  :language: javascript
197 
198 
199 Update group
200 ============
201 
202 .. rest_method:: PATCH /v3/groups/{group_id}
203 
204 Updates a group.
205 
206 If the back-end driver does not support this functionality, the
207 call returns the ``Not Implemented (501)`` response code.
208 
209 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group``
210 
211 Request
212 -------
213 
214 Parameters
215 ~~~~~~~~~~
216 
217 .. rest_parameters:: parameters.yaml
218 
219  - group_id: group_id_path
220  - group: group
221  - description: group_description_update_request_body
222  - domain_id: group_domain_id_update_request_body
223  - name: group_name_update_request_body
224 
225 Example
226 ~~~~~~~
227 
228 .. literalinclude:: ./samples/admin/group-update-request.json
229  :language: javascript
230 
231 Response
232 --------
233 
234 Parameters
235 ~~~~~~~~~~
236 
237 .. rest_parameters:: parameters.yaml
238 
239  - group: group
240  - description: group_description_response_body
241  - domain_id: group_domain_id_response_body
242  - id: group_id_response_body
243  - links: link_response_body
244  - name: group_name_response_body
245 
246 Status Codes
247 ~~~~~~~~~~~~
248 
249 .. rest_status_code:: success status.yaml
250 
251  - 200
252 
253 .. rest_status_code:: error status.yaml
254 
255  - 400
256  - 401
257  - 403
258  - 404
259  - 409
260  - 501
261 
262 Example
263 ~~~~~~~
264 
265 .. literalinclude:: ./samples/admin/group-update-response.json
266  :language: javascript
267 
268 
269 Delete group
270 ============
271 
272 .. rest_method:: DELETE /v3/groups/{group_id}
273 
274 Deletes a group.
275 
276 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group``
277 
278 Request
279 -------
280 
281 Parameters
282 ~~~~~~~~~~
283 
284 .. rest_parameters:: parameters.yaml
285 
286  - group_id: group_id_path
287 
288 Response
289 --------
290 
291 Status Codes
292 ~~~~~~~~~~~~
293 
294 .. rest_status_code:: success status.yaml
295 
296  - 204
297 
298 .. rest_status_code:: error status.yaml
299 
300  - 400
301  - 401
302  - 403
303  - 404
304 
305 
306 List users in group
307 ===================
308 
309 .. rest_method:: GET /v3/groups/{group_id}/users
310 
311 Lists the users that belong to a group.
312 
313 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_users``
314 
315 Request
316 -------
317 
318 Parameters
319 ~~~~~~~~~~
320 
321 .. rest_parameters:: parameters.yaml
322 
323  - group_id: group_id_path
324  - password_expires_at: password_expires_at_query
325 
326 Response
327 --------
328 
329 Status Codes
330 ~~~~~~~~~~~~
331 
332 .. rest_status_code:: success status.yaml
333 
334  - 200
335 
336 .. rest_status_code:: error status.yaml
337 
338  - 400
339  - 401
340  - 403
341  - 404
342 
343 Example
344 ~~~~~~~
345 
346 .. literalinclude:: ./samples/admin/group-users-list-response.json
347  :language: javascript
348 
349 
350 Add user to group
351 =================
352 
353 .. rest_method:: PUT /v3/groups/{group_id}/users/{user_id}
354 
355 Adds a user to a group.
356 
357 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user``
358 
359 Request
360 -------
361 
362 Parameters
363 ~~~~~~~~~~
364 
365 .. rest_parameters:: parameters.yaml
366 
367  - user_id: user_id_path
368  - group_id: group_id_path
369 
370 Response
371 --------
372 
373 Status Codes
374 ~~~~~~~~~~~~
375 
376 .. rest_status_code:: success status.yaml
377 
378  - 204
379 
380 .. rest_status_code:: error status.yaml
381 
382  - 400
383  - 401
384  - 403
385  - 404
386 
387 
388 Check whether user belongs to group
389 ===================================
390 
391 .. rest_method:: HEAD /v3/groups/{group_id}/users/{user_id}
392 
393 Validates that a user belongs to a group.
394 
395 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user``
396 
397 Request
398 -------
399 
400 Parameters
401 ~~~~~~~~~~
402 
403 .. rest_parameters:: parameters.yaml
404 
405  - user_id: user_id_path
406  - group_id: group_id_path
407 
408 Response
409 --------
410 
411 Status Codes
412 ~~~~~~~~~~~~
413 
414 .. rest_status_code:: success status.yaml
415 
416  - 204
417 
418 .. rest_status_code:: error status.yaml
419 
420  - 400
421  - 401
422  - 403
423  - 404
424 
425 
426 Remove user from group
427 ======================
428 
429 .. rest_method:: DELETE /v3/groups/{group_id}/users/{user_id}
430 
431 Removes a user from a group.
432 
433 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/group_user``
434 
435 Request
436 -------
437 
438 Parameters
439 ~~~~~~~~~~
440 
441 .. rest_parameters:: parameters.yaml
442 
443  - user_id: user_id_path
444  - group_id: group_id_path
445 
446 Response
447 --------
448 
449 Status Codes
450 ~~~~~~~~~~~~
451 
452 .. rest_status_code:: success status.yaml
453 
454  - 204
455 
456 .. rest_status_code:: error status.yaml
457 
458  - 400
459  - 401
460  - 403
461  - 404
keystone.conf.application_credential.driver
driver
Definition: application_credential.py:18
conf.project
string project
Definition: conf.py:57
keystone.conf.auth.external
external
Definition: auth.py:47
keystone.conf.ldap.user
user
Definition: ldap.py:27
keystone.common.validation.parameter_types.name
dictionary name
Definition: parameter_types.py:25
keystone.common.validation.parameter_types.description
dictionary description
Definition: parameter_types.py:54