038c0e35ca
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 v3 extension docs to our repository under 'api-ref/source' directory. It also removes the OS-KDS docs, given it does not exist anymore. Missing parameters definitions were added. The API examples for the extensions were moved into '/v3-ext/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: I632ac0aaa8e1ba2eeb598f5fd80350ac0c5ad3c1
72 lines
1.8 KiB
ReStructuredText
72 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========================
|
|
Trust extension (OS-TRUST)
|
|
==========================
|
|
|
|
Creates a trust.
|
|
|
|
A trust is an OpenStack Identity extension that enables delegation
|
|
and, optionally, impersonation through ``keystone``. A trust
|
|
extension defines a relationship between a trustor and trustee. A
|
|
trustor is the user who delegates a limited set of their own rights
|
|
to another user, known as the trustee, for a limited time.
|
|
|
|
The trust can eventually enable the trustee to impersonate the
|
|
trustor. For security reasons, some safety measures are added. For
|
|
example, if a trustor loses a given role, the API automatically
|
|
revokes any trusts and the related tokens that the user issued with
|
|
that role.
|
|
|
|
For more information, see `Use trusts <http://docs.openstack.org
|
|
/admin-guide/keystone_use_trusts.html>`_.
|
|
|
|
|
|
Create trust
|
|
============
|
|
|
|
.. rest_method:: POST /v3/OS-TRUST/trusts
|
|
|
|
Creates a trust.
|
|
|
|
Error response codes:201,413,415,405,404,403,401,400,503,409,
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- impersonation: impersonation
|
|
- trust: trust
|
|
- trustor_user_id: trustor_user_id
|
|
- name: name
|
|
- roles: roles
|
|
- oauth_expires_at: oauth_expires_at
|
|
- remaining_uses: remaining_uses
|
|
- trustee_user_id: trustee_user_id
|
|
- project_id: project_id
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/OS-TRUST/trust-create-request.json
|
|
:language: javascript
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- impersonation: impersonation
|
|
- roles_links: roles_links
|
|
- trust: trust
|
|
- trustor_user_id: trustor_user_id
|
|
- name: name
|
|
- links: links
|
|
- oauth_expires_at: oauth_expires_at
|
|
- remaining_uses: remaining_uses
|
|
- trustee_user_id: trustee_user_id
|
|
- roles: roles
|
|
- project_id: project_id
|
|
- id: id
|