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)  

regions-v3.inc
Go to the documentation of this file.
1 .. -*- rst -*-
2 
3 =========
4  Regions
5 =========
6 
7 A region is a general division of an OpenStack deployment. You can
8 associate zero or more sub-regions with a region to create a tree-
9 like structured hierarchy.
10 
11 Although a region does not have a geographical connotation, a
12 deployment can use a geographical name for a region ID, such as ``us-
13 east``.
14 
15 You can list, create, update, show details for, and delete regions.
16 
17 
18 Show region details
19 ===================
20 
21 .. rest_method:: GET /v3/regions/{region_id}
22 
23 Shows details for a region, by ID.
24 
25 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
26 
27 Request
28 -------
29 
30 Parameters
31 ~~~~~~~~~~
32 
33 .. rest_parameters:: parameters.yaml
34 
35  - region_id: region_id_path
36 
37 Response
38 --------
39 
40 Parameters
41 ~~~~~~~~~~
42 
43 .. rest_parameters:: parameters.yaml
44 
45  - region: region_object
46  - description: description_region_response_body
47  - id: id_region_response_body
48  - links: links_region
49  - parent_region_id: parent_region_id_response_body
50 
51 Status Codes
52 ~~~~~~~~~~~~
53 
54 .. rest_status_code:: success status.yaml
55 
56  - 200
57 
58 .. rest_status_code:: error status.yaml
59 
60  - 400
61  - 401
62  - 403
63  - 404
64  - 405
65  - 413
66  - 503
67 
68 Example
69 ~~~~~~~
70 
71 .. literalinclude:: ./samples/admin/region-show-response.json
72  :language: javascript
73 
74 
75 Update region
76 =============
77 
78 .. rest_method:: PATCH /v3/regions/{region_id}
79 
80 Updates a region.
81 
82 You can update the description or parent region ID for a region.
83 You cannot update the region ID.
84 
85 The following error might occur:
86 
87 - ``Not Found (404)``. The parent region ID does not exist.
88 
89 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
90 
91 Request
92 -------
93 
94 Parameters
95 ~~~~~~~~~~
96 
97 .. rest_parameters:: parameters.yaml
98 
99  - region_id: region_id_path
100  - region: region_object
101  - description: description_region_request_body
102  - parent_region_id: parent_region_id_request_body
103 
104 Example
105 ~~~~~~~
106 
107 .. literalinclude:: ./samples/admin/region-update-request.json
108  :language: javascript
109 
110 Response
111 --------
112 
113 Parameters
114 ~~~~~~~~~~
115 
116 .. rest_parameters:: parameters.yaml
117 
118  - region: region_object
119  - description: description_region_response_body
120  - id: id_region_response_body
121  - links: links_region
122  - parent_region_id: parent_region_id_response_body
123 
124 Status Codes
125 ~~~~~~~~~~~~
126 
127 .. rest_status_code:: success status.yaml
128 
129  - 200
130 
131 .. rest_status_code:: error status.yaml
132 
133  - 400
134  - 401
135  - 403
136  - 404
137  - 405
138  - 409
139  - 413
140  - 415
141  - 503
142 
143 Example
144 ~~~~~~~
145 
146 .. literalinclude:: ./samples/admin/region-update-response.json
147  :language: javascript
148 
149 
150 Delete region
151 =============
152 
153 .. rest_method:: DELETE /v3/regions/{region_id}
154 
155 Deletes a region.
156 
157 The following error might occur:
158 
159 - ``Conflict (409)``. The region cannot be deleted because it has
160  child regions.
161 
162 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/region``
163 
164 Request
165 -------
166 
167 Parameters
168 ~~~~~~~~~~
169 
170 .. rest_parameters:: parameters.yaml
171 
172  - region_id: region_id_path
173 
174 Response
175 --------
176 
177 Status Codes
178 ~~~~~~~~~~~~
179 
180 .. rest_status_code:: success status.yaml
181 
182  - 204
183 
184 .. rest_status_code:: error status.yaml
185 
186  - 400
187  - 401
188  - 403
189  - 404
190  - 405
191  - 409
192  - 413
193  - 415
194  - 503
195 
196 List regions
197 ============
198 
199 .. rest_method:: GET /v3/regions
200 
201 Lists regions.
202 
203 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
204 
205 Request
206 -------
207 
208 Parameters
209 ~~~~~~~~~~
210 
211 .. rest_parameters:: parameters.yaml
212 
213  - parent_region_id: parent_region_id_query_not_required
214 
215 Response
216 --------
217 
218 Parameters
219 ~~~~~~~~~~
220 
221 .. rest_parameters:: parameters.yaml
222 
223  - regions: regions_object
224  - description: description_region_response_body
225  - id: id_region_response_body
226  - links: links_region
227  - parent_region_id: parent_region_id_response_body
228 
229 Status Codes
230 ~~~~~~~~~~~~
231 
232 .. rest_status_code:: success status.yaml
233 
234  - 200
235 
236 .. rest_status_code:: error status.yaml
237 
238  - 400
239  - 401
240  - 403
241  - 404
242  - 405
243  - 413
244  - 503
245 
246 Example
247 ~~~~~~~
248 
249 .. literalinclude:: ./samples/admin/regions-list-response.json
250  :language: javascript
251 
252 
253 Create region
254 =============
255 
256 .. rest_method:: POST /v3/regions
257 
258 Creates a region.
259 
260 When you create the region, you can optionally specify a region ID.
261 If you include characters in the region ID that are not allowed in
262 a URI, you must URL-encode the ID. If you omit an ID, the API
263 assigns an ID to the region.
264 
265 The following errors might occur:
266 
267 - ``Not Found (404)``. The parent region ID does not exist.
268 
269 - ``Conflict (409)``. The parent region ID would form a circular
270  relationship.
271 
272 - ``Conflict (409)``. The user-defined region ID is not unique to
273  the OpenStack deployment.
274 
275 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/regions``
276 
277 Request
278 -------
279 
280 Parameters
281 ~~~~~~~~~~
282 
283 .. rest_parameters:: parameters.yaml
284 
285  - region: region_object
286  - description: description_region_request_body
287  - id: id_region_resquest_body
288  - parent_region_id: parent_region_id_request_body
289 
290 Example
291 ~~~~~~~
292 
293 .. literalinclude:: ./samples/admin/region-create-request.json
294  :language: javascript
295 
296 Response
297 --------
298 
299 Parameters
300 ~~~~~~~~~~
301 
302 .. rest_parameters:: parameters.yaml
303 
304  - region: region_object
305  - description: description_region_response_body
306  - id: id_region_response_body
307  - links: links_region
308  - parent_region_id: parent_region_id_response_body
309 
310 Status Codes
311 ~~~~~~~~~~~~
312 
313 .. rest_status_code:: success status.yaml
314 
315  - 201
316 
317 .. rest_status_code:: error status.yaml
318 
319  - 400
320  - 401
321  - 403
322  - 404
323  - 405
324  - 409
325  - 413
326  - 415
327  - 503
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