Merge "v2 api: add APIs for setting a user's password"

This commit is contained in:
Jenkins 2016-07-19 01:50:27 +00:00 committed by Gerrit Code Review
commit 9adda34914
6 changed files with 66 additions and 8 deletions

View File

@ -28,7 +28,49 @@ Request
Request Example
---------------
.. literalinclude:: samples/OS-KSADM/userwithenabledonly-enable-request.json
.. literalinclude:: samples/OS-KSADM/user-set-enabled-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- email: email
- enabled: enabled
- id: id
- name: name
- username: username
Response Example
----------------
.. literalinclude:: samples/OS-KSADM/user-show-response.json
:language: javascript
Set user password
=================
.. rest_method:: PUT /v2.0/users/{userId}/OS-KSADM/password
Sets a user's password
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Request
-------
.. rest_parameters:: parameters.yaml
- userId: userId
- password: new_password
Request Example
---------------
.. literalinclude:: samples/OS-KSADM/user-set-password-request.json
:language: javascript
Response Parameters
@ -40,11 +82,12 @@ Response Parameters
- email: email
- name: name
- id: id
- username: username
Response Example
----------------
.. literalinclude:: samples/OS-KSADM/userwithenabledonly-show-response.json
.. literalinclude:: samples/OS-KSADM/user-show-response.json
:language: javascript

View File

@ -175,6 +175,12 @@ user:
in: body
required: true
type: string
username:
description: |
The user name.
in: body
required: false
type: string
users:
description: |
The ``users`` object.
@ -186,4 +192,4 @@ users_links:
The links of ``users`` object.
in: body
required: true
type: array
type: array

View File

@ -0,0 +1,5 @@
{
"user": {
"password": "new_password"
}
}

View File

@ -0,0 +1,9 @@
{
"user": {
"id": "3c9530e",
"name": "admin",
"email": "admin@example.org",
"username": "admin",
"enabled": true
}
}

View File

@ -1,5 +0,0 @@
{
"user": {
"enabled": true
}
}