73939d90cd
This addresses the warnings that os-api-ref 1.2.0 generates about undocumented parameters. Change-Id: I921ab1e2a05cd15885f789a4175c70056872f10a
163 lines
2.9 KiB
ReStructuredText
163 lines
2.9 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.
|
|
|
|
Normal response codes: 201
|
|
|
|
Error response codes: 413,415,405,404,403,401,400,503,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
|
|
|
|
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: 413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
|
|
|
|
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: 415,405,404,403,401,400,503,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
|
|
|
|
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.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 413,415,405,404,403,401,400,503,409,
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
|
|
|
|
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: 413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
|
|
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: 413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: user_id_path
|
|
- type: credential_type
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/OS-KSADM/credentials-show-response.json
|
|
:language: javascript
|