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)  

credentials.inc
Go to the documentation of this file.
1 .. -*- rst -*-
2 
3 =============
4  Credentials
5 =============
6 
7 In exchange for a set of authentication credentials that the user
8 submits, the Identity service generates and returns a token. A
9 token represents the authenticated identity of a user and,
10 optionally, grants authorization on a specific project or domain.
11 
12 You can list all credentials, and create, show details for, update,
13 and delete a credential.
14 
15 
16 Create credential
17 =================
18 
19 .. rest_method:: POST /v3/credentials
20 
21 Creates a credential.
22 
23 The following example shows how to create an EC2-style credential.
24 The credential blob is a string that contains a JSON-serialized
25 dictionary with the ``access`` and ``secret`` keys. This format is
26 required when you specify the ``ec2`` type. To specify other
27 credentials, such as ``access_key``, change the type and contents
28 of the data blob.
29 
30 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/credentials``
31 
32 Request
33 -------
34 
35 Parameters
36 ~~~~~~~~~~
37 
38 .. rest_parameters:: parameters.yaml
39 
40  - credential: credential
41  - project_id: project_id
42  - type: credential_type
43  - blob: credential_blob
44  - user_id: credential_user_id
45 
46 Example
47 ~~~~~~~
48 
49 .. literalinclude:: ./samples/admin/credential-create-request.json
50  :language: javascript
51 
52 Response
53 --------
54 
55 Parameters
56 ~~~~~~~~~~
57 
58 .. rest_parameters:: parameters.yaml
59 
60  - credential: credential
61  - user_id: credential_user_id
62  - links: credential_links
63  - blob: credential_blob
64  - project_id: project_id
65  - type: credential_type
66  - id: credential_id
67 
68 Status Codes
69 ~~~~~~~~~~~~
70 
71 .. rest_status_code:: success status.yaml
72 
73  - 201
74 
75 .. rest_status_code:: error status.yaml
76 
77  - 400
78  - 401
79  - 403
80  - 404
81  - 405
82  - 409
83  - 413
84  - 415
85  - 503
86 
87 Example
88 ~~~~~~~
89 
90 .. literalinclude:: ./samples/admin/credential-create-response.json
91  :language: javascript
92 
93 
94 List credentials
95 ================
96 
97 .. rest_method:: GET /v3/credentials
98 
99 Lists all credentials.
100 
101 Optionally, you can include the ``user_id`` or ``type`` query parameter in the
102 URI to filter the response by a user or credential type.
103 
104 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/credentials``
105 
106 Request
107 -------
108 
109 Parameters
110 ~~~~~~~~~~
111 
112 .. rest_parameters:: parameters.yaml
113 
114  - user_id: user_id_query
115  - type: credential_type_not_required
116 
117 Response
118 --------
119 
120 Parameters
121 ~~~~~~~~~~
122 
123 .. rest_parameters:: parameters.yaml
124 
125  - user_id: credential_user_id
126  - links: credentials_links
127  - blob: credential_blob
128  - credentials: credentials
129  - project_id: project_id
130  - type: credential_type
131  - id: credential_id
132 
133 Status Codes
134 ~~~~~~~~~~~~
135 
136 .. rest_status_code:: success status.yaml
137 
138  - 200
139 
140 .. rest_status_code:: error status.yaml
141 
142  - 400
143  - 401
144  - 403
145  - 404
146  - 405
147  - 413
148  - 503
149 
150 Example
151 ~~~~~~~
152 
153 .. literalinclude:: ./samples/admin/credentials-list-response.json
154  :language: javascript
155 
156 
157 Show credential details
158 =======================
159 
160 .. rest_method:: GET /v3/credentials/{credential_id}
161 
162 Shows details for a credential.
163 
164 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/credential``
165 
166 Request
167 -------
168 
169 Parameters
170 ~~~~~~~~~~
171 
172 .. rest_parameters:: parameters.yaml
173 
174  - credential_id: credential_id_path
175 
176 Response
177 --------
178 
179 Parameters
180 ~~~~~~~~~~
181 
182 .. rest_parameters:: parameters.yaml
183 
184  - credential: credential
185  - user_id: credential_user_id
186  - links: credential_links
187  - blob: credential_blob
188  - project_id: project_id
189  - type: credential_type
190  - id: credential_id
191 
192 Status Codes
193 ~~~~~~~~~~~~
194 
195 .. rest_status_code:: success status.yaml
196 
197  - 200
198 
199 .. rest_status_code:: error status.yaml
200 
201  - 400
202  - 401
203  - 403
204  - 404
205  - 405
206  - 413
207  - 503
208 
209 Example
210 ~~~~~~~
211 
212 .. literalinclude:: ./samples/admin/credential-show-response.json
213  :language: javascript
214 
215 
216 Update credential
217 =================
218 
219 .. rest_method:: PATCH /v3/credentials/{credential_id}
220 
221 Updates a credential.
222 
223 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/credential``
224 
225 Request
226 -------
227 
228 Parameters
229 ~~~~~~~~~~
230 
231 .. rest_parameters:: parameters.yaml
232 
233  - credential_id: credential_id_path
234  - credential: credential
235  - project_id: project_id
236  - type: credential_type_not_required
237  - blob: credential_blob_not_required
238  - user_id: credential_user_id_not_required
239 
240 Example
241 ~~~~~~~
242 
243 .. literalinclude:: ./samples/admin/credential-update-request.json
244  :language: javascript
245 
246 Response
247 --------
248 
249 Parameters
250 ~~~~~~~~~~
251 
252 .. rest_parameters:: parameters.yaml
253 
254  - credential: credential
255  - user_id: credential_user_id
256  - links: credential_links
257  - blob: credential_blob
258  - project_id: project_id
259  - type: credential_type
260  - id: credential_id
261 
262 Status Codes
263 ~~~~~~~~~~~~
264 
265 .. rest_status_code:: success status.yaml
266 
267  - 200
268 
269 .. rest_status_code:: error status.yaml
270 
271  - 400
272  - 401
273  - 403
274  - 404
275  - 405
276  - 409
277  - 413
278  - 415
279  - 503
280 
281 Example
282 ~~~~~~~
283 
284 .. literalinclude:: ./samples/admin/credential-update-response.json
285  :language: javascript
286 
287 
288 Delete credential
289 =================
290 
291 .. rest_method:: DELETE /v3/credentials/{credential_id}
292 
293 Deletes a credential.
294 
295 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/credential``
296 
297 Request
298 -------
299 
300 Parameters
301 ~~~~~~~~~~
302 
303 .. rest_parameters:: parameters.yaml
304 
305  - credential_id: credential_id_path
306 
307 Response
308 --------
309 
310 Status Codes
311 ~~~~~~~~~~~~
312 
313 .. rest_status_code:: success status.yaml
314 
315  - 204
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
conf.project
string project
Definition: conf.py:57
keystone.conf.auth.token
token
Definition: auth.py:38
keystone.conf.ldap.user
user
Definition: ldap.py:27