summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/trust.rst
diff options
context:
space:
mode:
authorSteve Martinelli <s.martinelli@gmail.com>2017-08-17 12:17:39 -0400
committerSteve Martinelli <s.martinelli@gmail.com>2017-10-06 00:57:04 +0000
commit0d94a76d956c0322e9c4607fb5ce824f7653f038 (patch)
tree5044ef180d214ce9a161739c5a6d748970e94766 /doc/source/cli/command-objects/trust.rst
parenta87bd58fb4de5dc5f99193b88d2a3f8bd1338c52 (diff)
downloadpython-openstackclient-0d94a76d956c0322e9c4607fb5ce824f7653f038.tar.gz
auto-generate docs for v3 identity resources
skipped shared v2/v3 identity resources. Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
Diffstat (limited to 'doc/source/cli/command-objects/trust.rst')
-rw-r--r--doc/source/cli/command-objects/trust.rst104
1 files changed, 10 insertions, 94 deletions
diff --git a/doc/source/cli/command-objects/trust.rst b/doc/source/cli/command-objects/trust.rst
index 28459bca..febef1c5 100644
--- a/doc/source/cli/command-objects/trust.rst
+++ b/doc/source/cli/command-objects/trust.rst
@@ -2,101 +2,17 @@
trust
=====
-Identity v3
+A **trust** provide project-specific role delegation between users, with
+optional impersonation. Requires the OS-TRUST extension. Applies to Identity v3.
-trust create
-------------
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: trust create
-Create new trust
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: trust delete
-.. program:: trust create
-.. code:: bash
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: trust list
- openstack trust create
- --project <project>
- --role <role>
- [--impersonate]
- [--expiration <expiration>]
- [--project-domain <domain>]
- [--trustor-domain <domain>]
- [--trustee-domain <domain>]
- <trustor>
- <trustee>
-
-.. option:: --project <project>
-
- Project being delegated (name or ID) (required)
-
-.. option:: --role <role>
-
- Roles to authorize (name or ID) (repeat option to set multiple values, required)
-
-.. option:: --impersonate
-
- Tokens generated from the trust will represent <trustor> (defaults to False)
-
-.. option:: --expiration <expiration>
-
- Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS)
-
-.. option:: --project-domain <project-domain>
-
- Domain the project belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
-.. option:: --trustor-domain <trustor-domain>
-
- Domain that contains <trustor> (name or ID)
-
-.. option:: --trustee-domain <trustee-domain>
-
- Domain that contains <trustee> (name or ID)
-
-.. describe:: <trustor-user>
-
- User that is delegating authorization (name or ID)
-
-.. describe:: <trustee-user>
-
- User that is assuming authorization (name or ID)
-
-
-trust delete
-------------
-
-Delete trust(s)
-
-.. program:: trust delete
-.. code:: bash
-
- openstack trust delete
- <trust> [<trust> ...]
-
-.. describe:: <trust>
-
- Trust(s) to delete
-
-trust list
-----------
-
-List trusts
-
-.. program:: trust list
-.. code:: bash
-
- openstack trust list
-
-trust show
-----------
-
-Display trust details
-
-.. program:: trust show
-.. code:: bash
-
- openstack trust show
- <trust>
-
-.. describe:: <trust>
-
- Trust to display
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: trust show