![Samuel de Medeiros Queiroz](/assets/img/avatar_default.png)
Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the v2 extension docs to our repository under 'api-ref/source' directory. It also removes the OS-KSCATALOG, OS-KSS3 and OS-KSVALIDATE docs, given they do not exist anymore. Missing parameters definitions were added. The API examples for the extensions were moved into '/v2-ext/samples'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If7adf10d0bb5fb07db70d4f42364fa0b50568a01
115 lines
2.4 KiB
ReStructuredText
115 lines
2.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
========================
|
|
OS-KSEC2 admin extension
|
|
========================
|
|
|
|
Supports Amazon Elastic Compute (EC2) style authentication.
|
|
|
|
|
|
Grant credential to user
|
|
========================
|
|
|
|
.. rest_method:: POST /v2.0/users/{userId}/OS-KSADM/credentials
|
|
|
|
Grants a credential to a user.
|
|
|
|
Error response codes:201,413,415,405,404,403,401,400,503,409,
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/OS-KSEC2/ec2Credentials-create-request.json
|
|
:language: javascript
|
|
|
|
|
|
List credentials (EC2 extension)
|
|
================================
|
|
|
|
.. rest_method:: GET /v2.0/users/{userId}/OS-KSADM/credentials
|
|
|
|
Lists credentials.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/OS-KSEC2/credentialswithec2-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update user credentials
|
|
=======================
|
|
|
|
.. rest_method:: POST /v2.0/users/{userId}/OS-KSADM/credentials/OS-KSEC2:ec2Credentials
|
|
|
|
Updates credentials for a user.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:413,415,405,404,403,401,400,503,409,
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/OS-KSEC2/ec2Credentials-create-request.json
|
|
:language: javascript
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/OS-KSEC2/ec2Credentials-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Delete user credentials
|
|
=======================
|
|
|
|
.. rest_method:: DELETE /v2.0/users/{userId}/OS-KSADM/credentials/OS-KSEC2:ec2Credentials
|
|
|
|
Deletes user credentials.
|
|
|
|
Error response codes:204,413,415,405,404,403,401,400,503,409,
|
|
|
|
|
|
Get user credentials
|
|
====================
|
|
|
|
.. rest_method:: GET /v2.0/users/{userId}/OS-KSADM/credentials/OS-KSEC2:ec2Credentials
|
|
|
|
Gets user credentials.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/OS-KSEC2/ec2Credentials-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
List credentials by type
|
|
========================
|
|
|
|
.. rest_method:: GET /v2.0/users/{userId}/OS-KSADM/credentials/OS-KSEC2:ec2Credentials/{type}
|
|
|
|
Lists credentials by type.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- type: type
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/OS-KSADM/credentials-show-response.json
|
|
:language: javascript
|