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)  

domains.inc
Go to the documentation of this file.
1 .. -*- rst -*-
2 
3 =========
4  Domains
5 =========
6 
7 A domain is a collection of users, groups, and projects. Each group
8 and project is owned by exactly one domain.
9 
10 Each domain defines a namespace where certain API-visible name
11 attributes exist, which affects whether those names must be
12 globally unique or unique within that domain. In the Identity API,
13 the uniqueness of these attributes is as follows:
14 
15 - *Domain name*. Globally unique across all domains.
16 
17 - *Role name*. Unique within the owning domain.
18 
19 - *User name*. Unique within the owning domain.
20 
21 - *Project name*. Unique within the owning domain.
22 
23 - *Group name*. Unique within the owning domain.
24 
25 List domains
26 ============
27 
28 .. rest_method:: GET /v3/domains
29 
30 Lists all domains.
31 
32 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
33 
34 Request
35 -------
36 
37 Parameters
38 ~~~~~~~~~~
39 
40 .. rest_parameters:: parameters.yaml
41 
42  - name: domain_name_query
43  - enabled: domain_enabled_query
44 
45 Response
46 --------
47 
48 Parameters
49 ~~~~~~~~~~
50 
51 .. rest_parameters:: parameters.yaml
52 
53  - domains: domains
54  - description: domain_description_response_body
55  - enabled: domain_enabled_response_body
56  - id: domain_id_response_body
57  - links: domain_link_response_body
58  - name: domain_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  - 404
73  - 405
74  - 413
75  - 503
76 
77 Example
78 ~~~~~~~
79 
80 .. literalinclude:: ./samples/admin/domains-list-response.json
81  :language: javascript
82 
83 
84 Create domain
85 =============
86 
87 .. rest_method:: POST /v3/domains
88 
89 Creates a domain.
90 
91 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
92 
93 Request
94 -------
95 
96 Parameters
97 ~~~~~~~~~~
98 
99 .. rest_parameters:: parameters.yaml
100 
101  - domain: domain
102  - explicit_domain_id: request_explicit_domain_id_body_not_required
103  - enabled: domain_enabled_request_body
104  - description: domain_description_request_body
105  - name: domain_name_request_body
106  - options: request_domain_options_body_not_required
107 
108 Example
109 ~~~~~~~
110 
111 .. literalinclude:: ./samples/admin/domain-create-request.json
112  :language: javascript
113 
114 Response
115 --------
116 
117 Parameters
118 ~~~~~~~~~~
119 
120 .. rest_parameters:: parameters.yaml
121 
122  - domain: domain
123  - description: domain_description_response_body
124  - enabled: domain_enabled_response_body
125  - id: domain_id_response_body
126  - links: domain_link_response_body
127  - name: domain_name_response_body
128  - options: response_role_options_body_required
129 
130 Status Codes
131 ~~~~~~~~~~~~
132 
133 .. rest_status_code:: success status.yaml
134 
135  - 201
136 
137 .. rest_status_code:: error status.yaml
138 
139  - 400
140  - 401
141  - 403
142  - 404
143  - 405
144  - 409
145  - 413
146  - 415
147  - 503
148 
149 
150 Show domain details
151 ===================
152 
153 .. rest_method:: GET /v3/domains/{domain_id}
154 
155 Shows details for a domain.
156 
157 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domains``
158 
159 Request
160 -------
161 
162 Parameters
163 ~~~~~~~~~~
164 
165 .. rest_parameters:: parameters.yaml
166 
167  - domain_id: domain_id_path
168 
169 Response
170 --------
171 
172 Parameters
173 ~~~~~~~~~~
174 
175 .. rest_parameters:: parameters.yaml
176 
177  - domain: domain
178  - description: domain_description_response_body
179  - enabled: domain_enabled_response_body
180  - id: domain_id_response_body
181  - links: domain_link_response_body
182  - name: domain_name_response_body
183  - options: response_role_options_body_required
184 
185 Status Codes
186 ~~~~~~~~~~~~
187 
188 .. rest_status_code:: success status.yaml
189 
190  - 200
191 
192 .. rest_status_code:: error status.yaml
193 
194  - 400
195  - 401
196  - 403
197  - 404
198  - 405
199  - 413
200  - 503
201 
202 Example
203 ~~~~~~~
204 
205 .. literalinclude:: ./samples/admin/domain-show-response.json
206  :language: javascript
207 
208 
209 Update domain
210 =============
211 
212 .. rest_method:: PATCH /v3/domains/{domain_id}
213 
214 Updates a domain.
215 
216 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domain``
217 
218 Request
219 -------
220 
221 Parameters
222 ~~~~~~~~~~
223 
224 .. rest_parameters:: parameters.yaml
225 
226  - domain_id: domain_id_path
227  - domain: domain
228  - enabled: domain_enabled_update_request_body
229  - description: domain_description_update_request_body
230  - name: domain_name_update_request_body
231  - options: request_domain_options_body_not_required
232 
233 Example
234 ~~~~~~~
235 
236 .. literalinclude:: ./samples/admin/domain-update-request.json
237  :language: javascript
238 
239 Response
240 --------
241 
242 Parameters
243 ~~~~~~~~~~
244 
245 .. rest_parameters:: parameters.yaml
246 
247  - domain: domain
248  - description: domain_description_response_body
249  - enabled: domain_enabled_response_body
250  - id: domain_id_response_body
251  - links: domain_link_response_body
252  - name: domain_name_response_body
253  - options: response_role_options_body_required
254 
255 Status Codes
256 ~~~~~~~~~~~~
257 
258 .. rest_status_code:: success status.yaml
259 
260  - 200
261 
262 .. rest_status_code:: error status.yaml
263 
264  - 400
265  - 401
266  - 403
267  - 404
268  - 405
269  - 409
270  - 413
271  - 415
272  - 503
273 
274 Example
275 ~~~~~~~
276 
277 .. literalinclude:: ./samples/admin/domain-update-response.json
278  :language: javascript
279 
280 
281 Delete domain
282 =============
283 
284 .. rest_method:: DELETE /v3/domains/{domain_id}
285 
286 Deletes a domain.
287 To minimize the risk of accidentally deleting a domain, you must
288 first disable the domain by using the update domain method.
289 
290 When you delete a domain, this call also deletes all entities owned
291 by it, such as users, groups, and projects, and any credentials and
292 granted roles that relate to those entities.
293 
294 If you try to delete an enabled domain, this call returns the
295 ``Forbidden (403)`` response code.
296 
297 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/domain``
298 
299 Request
300 -------
301 
302 Parameters
303 ~~~~~~~~~~
304 
305 .. rest_parameters:: parameters.yaml
306 
307  - domain_id: domain_id_path
308 
309 Status Codes
310 ~~~~~~~~~~~~
311 
312 .. rest_status_code:: success status.yaml
313 
314  - 204
315 
316 .. rest_status_code:: error status.yaml
317 
318  - 400
319  - 401
320  - 403
321  - 404
322  - 405
323  - 409
324  - 413
325  - 415
326  - 503
conf.project
string project
Definition: conf.py:57
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