11d6b32fd4
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 admin docs to our repository under 'api-ref/source' directory. Missing parameters definitions were added. It also removes admin-extensions.inc as it did not contain any information. The operation of listing roles for user had it title renamed so there is not a duplicate label warning when running the api-ref job. The API examples were moved into '/v2-admin/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: I39d6c6197a939d77fc462c091051760d6b626d80
218 lines
3.9 KiB
ReStructuredText
218 lines
3.9 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=====
|
|
Users
|
|
=====
|
|
|
|
|
|
List user global roles
|
|
======================
|
|
|
|
.. rest_method:: GET /v2.0/users/{userId}/roles
|
|
|
|
Lists global roles for a user. Excludes tenant roles.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: userId
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- roles_links: roles_links
|
|
- roles: roles
|
|
- description: description
|
|
- name: name
|
|
- id: id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/admin/roles-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Create user (admin endpoint)
|
|
============================
|
|
|
|
.. rest_method:: POST /v2.0/users
|
|
|
|
Creates a user.
|
|
|
|
Error response codes:201,413,415,405,404,403,401,400,503,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenantId: tenantId
|
|
- password: password
|
|
- enabled: enabled
|
|
- email: email
|
|
- name: name
|
|
- X-Auth-Token: X-Auth-Token
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/admin/user-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- username: username
|
|
- enabled: enabled
|
|
- email: email
|
|
- name: name
|
|
- id: id
|
|
|
|
|
|
List users (admin endpoint)
|
|
===========================
|
|
|
|
.. rest_method:: GET /v2.0/users
|
|
|
|
Lists all users.
|
|
|
|
To show detailed information about a user by name, include the
|
|
``name`` query parameter in the request.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- username: username
|
|
- users: users
|
|
- enabled: enabled
|
|
- id: id
|
|
- email: email
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/admin/user-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
Update user (admin endpoint)
|
|
============================
|
|
|
|
.. rest_method:: PUT /v2.0/users/{userId}
|
|
|
|
Updates a user.
|
|
|
|
Error response codes:201,413,415,405,404,403,401,400,503,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- username: username
|
|
- enabled: enabled
|
|
- email: email
|
|
- name: name
|
|
- userId: userId
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/admin/user-update-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- enabled: enabled
|
|
- email: email
|
|
- name: name
|
|
- id: id
|
|
|
|
|
|
Delete user (admin endpoint)
|
|
============================
|
|
|
|
.. rest_method:: DELETE /v2.0/users/{userId}
|
|
|
|
Deletes a user.
|
|
|
|
Error response codes:204,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: userId
|
|
|
|
|
|
Show user details (admin endpoint)
|
|
==================================
|
|
|
|
.. rest_method:: GET /v2.0/users/{userId}
|
|
|
|
Shows details for a user, by ID.
|
|
|
|
The `openstack user show <http://docs.openstack.org/cli-
|
|
reference/openstack.html#openstack-user-show>`_ command supports
|
|
showing user details by name or ID. However, the command actually
|
|
looks up the user ID for a user name and queries the user by ID.
|
|
|
|
As a workaround, complete these steps to show details for a user by
|
|
name:
|
|
|
|
- `List all users <http://developer.openstack.org/api-ref-identity-
|
|
admin-v2.html#admin-listUsers>`_.
|
|
|
|
- In the response, find the user name for which you want to show
|
|
details and note its corresponding user ID.
|
|
|
|
- `Show details for user <http://developer.openstack.org/api-ref-
|
|
identity-admin-v2.html#admin-showUser>`_.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: userId
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- username: username
|
|
- enabled: enabled
|
|
- email: email
|
|
- name: name
|
|
- id: id
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/admin/user-show-response.json
|
|
:language: javascript
|