Merge "Command object docs: project, role, user"

4 files changed, 564 insertions, 0 deletions

diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst
new file mode 100644
index 00000000..ba741d1d
--- /dev/null
+++ b/doc/source/command-objects/project.rst
@@ -0,0 +1,155 @@
+=======
+project
+=======
+
+Identity v2, v3
+
+project create
+--------------
+
+Create new project
+
+.. program:: project create
+.. code:: bash
+
+    os project create
+        [--domain <domain>]
+        [--description <description>]
+        [--enable | --disable]
+        [--property <key=value>]
+        <name>
+
+.. option:: --domain <domain>
+
+    Domain owning the project (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --description <description>
+
+    Project description
+
+.. option:: --enable
+
+    Enable project (default)
+
+.. option:: --disable
+
+    Disable project
+
+.. option:: --property <key=value>
+
+    Add a property to :ref:`\<name\> <project_create-name>`
+    (repeat option to set multiple properties)
+
+.. _project_create-name:
+.. describe:: <name>
+
+    New project name
+
+project delete
+--------------
+
+Delete an existing project
+
+.. program:: project delete
+.. code:: bash
+
+    os project delete
+        <project>
+
+.. _project_delete-project:
+.. describe:: <project>
+
+    Project to delete (name or ID)
+
+project list
+------------
+
+List projects
+
+.. program:: project list
+.. code:: bash
+
+    os project list
+        [--domain <domain>]
+        [--long]
+
+.. option:: --domain <domain>
+
+    Filter projects by :option:`\<domain\> <--domain>` (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --long
+
+    List additional fields in output
+
+project set
+-----------
+
+Set project properties
+
+.. program:: project set
+.. code:: bash
+
+    os project set
+        [--name <name>]
+        [--domain <domain>]
+        [--description <description>]
+        [--enable | --disable]
+        [--property <key=value>]
+        <project>
+
+.. option:: --name <name>
+
+    Set project name
+
+.. option:: --domain <domain>
+
+    Set domain owning :ref:`\<project\> <project_set-project>` (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --description <description>
+
+    Set project description
+
+.. option:: --enable
+
+    Enable project (default)
+
+.. option:: --disable
+
+    Disable project
+
+.. option:: --property <key=value>
+
+    Set a property on :ref:`\<project\> <project_set-project>`
+    (repeat option to set multiple properties)
+
+.. _project_set-project:
+.. describe:: <project>
+
+    Project to modify (name or ID)
+
+project show
+------------
+
+.. program:: project show
+.. code:: bash
+
+    os project show
+        [--domain <domain>]
+        <project>
+
+.. option:: --domain <domain>
+
+    Domain owning :ref:`\<project\> <project_show-project>` (name or ID)
+
+    .. versionadded:: 3
+
+.. _project_show-project:
+.. describe:: <project>
+
+    Project to show (name or ID)
diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst
new file mode 100644
index 00000000..1cc80d7d
--- /dev/null
+++ b/doc/source/command-objects/role.rst
@@ -0,0 +1,180 @@
+====
+role
+====
+
+Identity v2, v3
+
+role add
+--------
+
+Add role to a user or group in a project or domain
+
+.. program:: role add
+.. code:: bash
+
+    os role add
+        --domain <domain> | --project <project>
+        --user <user> | --group <group>
+        <role>
+
+.. option:: --domain <domain>
+
+    Include `<domain>` (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --project <project>
+
+    Include `<project>` (name or ID)
+
+.. option:: --user <user>
+
+    Include `<user>` (name or ID)
+
+.. option:: --group <group>
+
+    Include `<group>` (name or ID)
+
+    .. versionadded:: 3
+
+.. describe:: <role>
+
+    Role to add to `<project>`:`<user>` (name or ID)
+
+role create
+-----------
+
+Create new role
+
+.. program:: role create
+.. code:: bash
+
+    os role create
+        <name>
+
+.. describe:: <name>
+
+    New role name
+
+role delete
+-----------
+
+Delete an existing role
+
+.. program:: role delete
+.. code:: bash
+
+    os role delete
+        <role>
+
+.. option:: <role>
+
+    Role to delete (name or ID)
+
+role list
+---------
+
+List roles
+
+.. program:: role list
+.. code:: bash
+
+    os role list
+        [--domain <domain> | --project <project]
+        [--user <user> | --group <group>]
+
+.. option:: --domain <domain>
+
+    Filter roles by <domain> (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --project <project>
+
+    Filter roles by <project> (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --user <user>
+
+    Filter roles by <user> (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --group <group>
+
+    Filter roles by <group> (name or ID)
+
+    .. versionadded:: 3
+
+role remove
+-----------
+
+Remove role from domain/project : user/group
+
+.. program:: role remove
+.. code:: bash
+
+    os role remove
+        [--domain <domain> | --project <project]
+        [--user <user> | --group <group>]
+        <role>
+
+.. option:: --domain <domain>
+
+    Include `<domain>` (name or ID)
+
+    .. versionadded:: 3
+
+.. option:: --project <project>
+
+    Include `<project>` (name or ID)
+
+.. option:: --user <user>
+
+    Include `<user>` (name or ID)
+
+.. option:: --group <group>
+
+    Include `<group>` (name or ID)
+
+    .. versionadded:: 3
+
+.. describe:: <role>
+
+    Role to remove from `<project>`:`<user>` (name or ID)
+
+role set
+--------
+
+Set role properties
+
+.. versionadded:: 3
+
+.. program:: role set
+.. code:: bash
+
+    os role set
+        [--name <name>]
+        <role>
+
+.. option:: --name <name>
+
+    Set role name
+
+.. describe:: <role>
+
+    Role to modify (name or ID)
+
+role show
+---------
+
+.. program:: role show
+.. code:: bash
+
+    os role show
+        <role>
+
+.. describe:: <role>
+
+    Role to show (name or ID)
diff --git a/doc/source/command-objects/user-role.rst b/doc/source/command-objects/user-role.rst
new file mode 100644
index 00000000..a25e90ff
--- /dev/null
+++ b/doc/source/command-objects/user-role.rst
@@ -0,0 +1,25 @@
+=========
+user role
+=========
+
+user role list
+--------------
+
+List user-role assignments
+
+*Removed in version 3.*
+
+.. program:: user role list
+.. code:: bash
+
+    os user role list
+        [--project <project>]
+        [<user>]
+
+.. option:: --project <project>
+
+    Filter users by `<project>` (name or ID)
+
+.. describe:: <user>
+
+    User to list (name or ID)
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)