summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/credential.rst
diff options
context:
space:
mode:
authorHuanxuan Ao <huanxuan.ao@easystack.cn>2016-07-13 17:33:52 +0800
committerHuanxuan Ao <huanxuan.ao@easystack.cn>2016-07-15 10:54:45 +0800
commitc0467edc647bd3cce00829daf1af53bab330e040 (patch)
tree054957f559746ec0992426b6547dd7c00143e467 /doc/source/command-objects/credential.rst
parent5a21eb25558c4820bdf1eec3f0d25fca00e7fd24 (diff)
downloadpython-openstackclient-c0467edc647bd3cce00829daf1af53bab330e040.tar.gz
Update doc for credential in indentityv3
Change-Id: I5f49c038a75ea67674b6d9279a6e60d6ded8d12f
Diffstat (limited to 'doc/source/command-objects/credential.rst')
-rw-r--r--doc/source/command-objects/credential.rst108
1 files changed, 97 insertions, 11 deletions
diff --git a/doc/source/command-objects/credential.rst b/doc/source/command-objects/credential.rst
index ed8a00db..538362a8 100644
--- a/doc/source/command-objects/credential.rst
+++ b/doc/source/command-objects/credential.rst
@@ -1,27 +1,113 @@
-===========
+==========
credential
-===========
+==========
Identity v3
credential create
-------------------
+-----------------
-.. ''[consider rolling the ec2 creds into this too]''
+Create new credential
+.. program:: credential create
.. code:: bash
os credential create
- --x509
- [<private-key-file>]
- [<certificate-file>]
+ [--type <type>]
+ [--project <project>]
+ <user> <data>
+
+.. option:: --type <type>
+
+ New credential type
+
+.. option:: --project <project>
+
+ Project which limits the scope of the credential (name or ID)
+
+.. _credential_create:
+.. describe:: <user>
+
+ User that owns the credential (name or ID)
+
+.. describe:: <data>
+
+ New credential data
+
+credential delete
+-----------------
+
+Delete credential(s)
+
+.. program:: credential delete
+.. code:: bash
+
+ os credential delete
+ <credential-id> [<credential-id> ...]
+
+.. _credential_delete:
+.. describe:: <credential-id>
+
+ ID(s) of credential to delete
+
+credential list
+---------------
+
+List credentials
+
+.. program:: credential list
+.. code:: bash
+
+ os credential list
+
+credential set
+--------------
+
+Set credential properties
+
+.. program:: credential set
+.. code:: bash
+
+ os credential set
+ [--user <user>]
+ [--type <type>]
+ [--data <data>]
+ [--project <project>]
+ <credential-id>
+
+.. option:: --user <user>
+
+ User that owns the credential (name or ID)
+
+.. option:: --type <type>
+
+ New credential type
+
+.. option:: --data <data>
+
+ New credential data
+
+.. option:: --project <project>
+
+ Project which limits the scope of the credential (name or ID)
+
+.. _credential_set:
+.. describe:: <credential-id>
+
+ ID of credential to change
credential show
-----------------
+---------------
+
+Display credential details
+.. program:: credential show
.. code:: bash
os credential show
- [--token]
- [--user]
- [--x509 [--root]]
+ <credential-id>
+
+.. _credential_show:
+.. describe:: <credential-id>
+
+ ID of credential to display