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

1 files changed, 180 insertions, 0 deletions

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)