summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/user.rst
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2014-11-18 15:11:32 -0600
committerSteve Martinelli <stevemar@ca.ibm.com>2014-12-01 17:36:20 -0500
commit04d30c1855f1229d986c7ad3bdae43a2b2d38990 (patch)
treee7bb3db5d38e1e560839d56c4aae9a6f96e61755 /doc/source/command-objects/user.rst
parent7e6b68ded99c86a4e24e548445f6ae03262ef259 (diff)
downloadpython-openstackclient-04d30c1855f1229d986c7ad3bdae43a2b2d38990.tar.gz
Command object docs: project, role, user
project role user user role Change-Id: I445e09a3ffb69114912ae562a9285963a636bfd1
Diffstat (limited to 'doc/source/command-objects/user.rst')
-rw-r--r--doc/source/command-objects/user.rst204
1 files changed, 204 insertions, 0 deletions
diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst
new file mode 100644
index 00000000..53becf27
--- /dev/null
+++ b/doc/source/command-objects/user.rst
@@ -0,0 +1,204 @@
+====
+user
+====
+
+Identity v2, v3
+
+user create
+-----------
+
+Create new user
+
+.. program:: user create
+.. code:: bash
+
+ os user create
+ [--domain <domain>]
+ [--project <project>]
+ [--password <password>]
+ [--password-prompt]
+ [--email <email-address>]
+ [--description <description>]
+ [--enable | --disable]
+ [--or-show]
+ <user-name>
+
+.. option:: --domain <domain>
+
+ Default domain (name or ID)
+
+ .. versionadded:: 3
+
+.. option:: --project <project>
+
+ Default project (name or ID)
+
+.. option:: --password <password>
+
+ Set user password
+
+.. option:: --password-prompt
+
+ Prompt interactively for password
+
+.. option:: --email <email-address>
+
+ Set user email address
+
+.. option:: --description <description>
+
+ User description
+
+ .. versionadded:: 3
+
+.. option:: --enable
+
+ Enable user (default)
+
+.. option:: --disable
+
+ Disable user
+
+.. option:: --or-show
+
+ Return existing user
+
+ If the username already exist return the existing user data and do not fail.
+
+.. describe:: <name>
+
+ New user name
+
+user delete
+-----------
+
+Delete user
+
+.. program:: user delete
+.. code:: bash
+
+ os user delete
+ <user>
+
+.. describe:: <user>
+
+ User to delete (name or ID)
+
+user list
+---------
+
+List users
+
+.. program:: user list
+.. code:: bash
+
+ os user list
+ [--domain <domain>]
+ [--project <project>]
+ [--group <group>]
+ [--long]
+
+.. option:: --domain <domain>
+
+ Filter users by `<domain>` (name or ID)
+
+ .. versionadded:: 3
+
+.. option:: --project <project>
+
+ Filter users by `<project>` (name or ID)
+
+ *Removed in version 3.*
+
+.. option:: --group <group>
+
+ Filter users by `<group>` membership (name or ID)
+
+ .. versionadded:: 3
+
+.. option:: --long
+
+ List additional fields in output
+
+user set
+--------
+
+Set user properties
+
+.. program:: user set
+.. code:: bash
+
+ os user set
+ [--name <name>]
+ [--domain <domain>]
+ [--project <project>]
+ [--password <password>]
+ [--email <email-address>]
+ [--description <description>]
+ [--enable|--disable]
+ <user>
+
+.. option:: --name <name>
+
+ Set user name
+
+.. option:: --domain <domain>
+
+ Set default domain (name or ID)
+
+ .. versionadded:: 3
+
+.. option:: --project <project>
+
+ Set default project (name or ID)
+
+.. option:: --password <password>
+
+ Set user password
+
+.. option:: --password-prompt
+
+ Prompt interactively for password
+
+.. option:: --email <email-address>
+
+ Set user email address
+
+.. option:: --description <description>
+
+ Set user description
+
+ .. versionadded:: 3
+
+.. option:: --enable
+
+ Enable user (default)
+
+.. option:: --disable
+
+ Disable user
+
+.. describe:: <user>
+
+ User to modify (name or ID)
+
+user show
+---------
+
+.. program:: user show
+.. code:: bash
+
+ os user show
+ [--domain <domain>]
+ <user>
+
+.. option:: --domain <domain>
+
+ Domain owning :ref:`\<user\> <user_show-user>` (name or ID)
+
+ .. versionadded:: 3
+
+.. _user_show-user:
+.. describe:: <user>
+
+ User to show (name or ID)