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
107 lines
1.8 KiB
ReStructuredText
107 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
=======
|
|
Tenants
|
|
=======
|
|
|
|
|
|
Show tenant details, by ID
|
|
==========================
|
|
|
|
.. rest_method:: GET /v2.0/tenants/{tenantId}
|
|
|
|
Shows details for a tenant, by ID.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenantId: tenantId
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/admin/tenant-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
List roles for user
|
|
===================
|
|
|
|
.. rest_method:: GET /v2.0/tenants/{tenantId}/users/{userId}/roles
|
|
|
|
Lists roles for a user on a tenant. Excludes global roles.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- userId: userId
|
|
- tenantId: tenantId
|
|
|
|
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
|
|
|
|
|
|
List tenants (admin endpoint)
|
|
=============================
|
|
|
|
.. rest_method:: GET /v2.0/tenants
|
|
|
|
Lists all tenants.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../v2/samples/admin/tenants-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show tenant details, by name
|
|
============================
|
|
|
|
.. rest_method:: GET /v2.0/tenants
|
|
|
|
Shows details for a tenant, by name.
|
|
|
|
Normal response codes: 200
|
|
Error response codes:203,413,405,404,403,401,400,503,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- name: name
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/admin/tenant-show-response.json
|
|
:language: javascript
|