summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/group.rst62
-rw-r--r--doc/source/command-objects/role.rst50
2 files changed, 107 insertions, 5 deletions
diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst
index 6c385058..0f2c5cd1 100644
--- a/doc/source/command-objects/group.rst
+++ b/doc/source/command-objects/group.rst
@@ -13,9 +13,25 @@ Add user to group
.. code:: bash
os group add user
+ [--group-domain <group-domain>]
+ [--user-domain <user-domain>]
<group>
<user>
+.. option:: --group-domain <group-domain>
+
+ Domain the group belongs to (name or ID). This can be
+ used in case collisions between group names exist.
+
+ .. versionadded:: 3
+
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
.. describe:: <group>
Group to contain <user> (name or ID)
@@ -33,9 +49,25 @@ Check user membership in group
.. code:: bash
os group contains user
+ [--group-domain <group-domain>]
+ [--user-domain <user-domain>]
<group>
<user>
+.. option:: --group-domain <group-domain>
+
+ Domain the group belongs to (name or ID). This can be
+ used in case collisions between group names exist.
+
+ .. versionadded:: 3
+
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
.. describe:: <group>
Group to check (name or ID)
@@ -106,7 +138,7 @@ List groups
os group list
[--domain <domain>]
- [--user <user>]
+ [--user <user> [--user-domain <user-domain>]]
[--long]
.. option:: --domain <domain>
@@ -117,6 +149,13 @@ List groups
Filter group list by <user> (name or ID)
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
.. option:: --long
List additional fields in output
@@ -130,9 +169,25 @@ Remove user from group
.. code:: bash
os group remove user
+ [--group-domain <group-domain>]
+ [--user-domain <user-domain>]
<group>
<user>
+.. option:: --group-domain <group-domain>
+
+ Domain the group belongs to (name or ID). This can be
+ used in case collisions between group names exist.
+
+ .. versionadded:: 3
+
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID). This can be
+ used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
.. describe:: <group>
Group containing <user> (name or ID)
@@ -150,10 +205,15 @@ Set group properties
.. code:: bash
os group set
+ [--domain <domain>]
[--name <name>]
[--description <description>]
<group>
+.. option:: --domain <domain>
+
+ Domain containing <group> (name or ID)
+
.. option:: --name <name>
New group name
diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst
index 3672cfa1..dad5642d 100644
--- a/doc/source/command-objects/role.rst
+++ b/doc/source/command-objects/role.rst
@@ -101,8 +101,8 @@ List roles
.. code:: bash
os role list
- [--domain <domain> | --project <project]
- [--user <user> | --group <group>]
+ --domain <domain> | --project <project> [--project-domain <project-domain>]
+ --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
.. option:: --domain <domain>
@@ -128,6 +128,27 @@ List roles
.. versionadded:: 3
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID).
+ This can be used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+.. option:: --group-domain <group-domain>
+
+ Domain the group belongs to (name or ID).
+ This can be used in case collisions between group names exist.
+
+ .. versionadded:: 3
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+ .. versionadded:: 3
+
role remove
-----------
@@ -137,8 +158,8 @@ Remove role from domain/project : user/group
.. code:: bash
os role remove
- [--domain <domain> | --project <project]
- [--user <user> | --group <group>]
+ --domain <domain> | --project <project> [--project-domain <project-domain>]
+ --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
<role>
.. option:: --domain <domain>
@@ -161,6 +182,27 @@ Remove role from domain/project : user/group
.. versionadded:: 3
+.. option:: --user-domain <user-domain>
+
+ Domain the user belongs to (name or ID).
+ This can be used in case collisions between user names exist.
+
+ .. versionadded:: 3
+
+.. option:: --group-domain <group-domain>
+
+ Domain the group belongs to (name or ID).
+ This can be used in case collisions between group names exist.
+
+ .. versionadded:: 3
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
+ .. versionadded:: 3
+
.. describe:: <role>
Role to remove (name or ID)