Remove v2.0 identity API documentation
Since we removed the v2.0 identity API: Icfd519f527de0e3945a858ce7f87ddadef766faa We can remove these documents since the no longer apply. bp removed-as-of-queens Change-Id: I645367ecdcd62d6b55b182c0550ef351fedf06d8
This commit is contained in:
parent
78eae3d497
commit
0286c3a92a
api-ref/source/v2-ext
@ -6,6 +6,5 @@
|
||||
|
||||
.. rest_expand_all::
|
||||
|
||||
.. include:: ksadm-admin.inc
|
||||
.. include:: ksec2-admin.inc
|
||||
.. include:: kscrud.inc
|
||||
|
@ -1,142 +0,0 @@
|
||||
.. -*- rst -*-
|
||||
|
||||
========================
|
||||
OS-KSADM admin extension
|
||||
========================
|
||||
|
||||
Supports create, read, update, and delete (CRUD) operations for
|
||||
users. Requires administrator privileges.
|
||||
|
||||
|
||||
Enable (Disable) user
|
||||
=====================
|
||||
|
||||
.. rest_method:: PUT /v2.0/users/{user_id}/OS-KSADM/enabled
|
||||
|
||||
Enables or disables a user.
|
||||
|
||||
Normal response codes: 200
|
||||
Error response codes: 413,415,405,404,403,401,400,503,409
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- user_id: user_id_path
|
||||
- enabled: user_enabled
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-set-enabled-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- user: user
|
||||
- email: user_email
|
||||
- enabled: user_enabled
|
||||
- id: user_id_response
|
||||
- name: user_name
|
||||
- username: user_name
|
||||
- tenantId: tenant_id_response
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Set user password
|
||||
=================
|
||||
|
||||
.. rest_method:: PUT /v2.0/users/{user_id}/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
|
||||
|
||||
- user_id: user_id_path
|
||||
- password: user_new_password
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-set-password-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- user: user
|
||||
- enabled: user_enabled
|
||||
- email: user_email
|
||||
- name: user_name
|
||||
- username: user_name
|
||||
- id: user_id_response
|
||||
- tenantId: tenant_id_response
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-show-response.json
|
||||
:language: javascript
|
||||
|
||||
|
||||
Update user tenant
|
||||
==================
|
||||
|
||||
.. rest_method:: PUT /v2.0/users/{user_id}/OS-KSADM/tenant
|
||||
|
||||
Sets a user's tenant
|
||||
|
||||
Normal response codes: 200
|
||||
|
||||
Error response codes: 413, 415, 405, 404, 403, 401, 400, 503, 409
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- user_id: user_id_path
|
||||
- tenantId: tenant_id_request
|
||||
|
||||
Request Example
|
||||
---------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-update-tenant-request.json
|
||||
:language: javascript
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- user: user
|
||||
- email: user_email
|
||||
- enabled: user_enabled
|
||||
- tenant: tenant_id_response
|
||||
- id: user_id_response
|
||||
- name: user_name
|
||||
- username: user_name
|
||||
- tenantId: tenant_id_response
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/OS-KSADM/user-show-response.json
|
||||
:language: javascript
|
@ -112,18 +112,6 @@ tenant:
|
||||
in: body
|
||||
required: true
|
||||
type: object
|
||||
tenant_id_request:
|
||||
description: |
|
||||
The tenant ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
tenant_id_response:
|
||||
description: |
|
||||
The tenant ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
user:
|
||||
description: |
|
||||
The ``user`` object.
|
||||
@ -136,19 +124,6 @@ user_email:
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
user_enabled:
|
||||
description: |
|
||||
Indicates whether the user should be enabled (``true``)
|
||||
or disabled(``false``).
|
||||
in: body
|
||||
required: true
|
||||
type: boolean
|
||||
user_id_response:
|
||||
description: |
|
||||
The user ID.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
user_name:
|
||||
description: |
|
||||
The user in-real-life name.
|
||||
|
@ -1,5 +0,0 @@
|
||||
{
|
||||
"user": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
@ -1,5 +0,0 @@
|
||||
{
|
||||
"user": {
|
||||
"password": "new_password"
|
||||
}
|
||||
}
|
@ -1,5 +0,0 @@
|
||||
{
|
||||
"user": {
|
||||
"tenantId": "1ca8e0"
|
||||
}
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user