Juan Antonio Osorio Robles 3ca96ef93c Enable specifing domains in "role add"
If users, projects or groups are provided by name, there is a
possibility of the existence other users/projects/groups with the same
name in other domain.  Even though this is not a problem if the actual
ID is given instead of a name; this is mostly a usability enhancement.

So, three options were added, one for specifying the domain where the
user belongs, another one to specify the project's domain, and finally
one to specify the group's domain.

Change-Id: Iab04b0e04fa75ea5aa3723b8ea42a45f58a6cdb2
Closes-Bug: #1421328
2015-05-12 11:48:01 +03:00

204 lines
3.1 KiB
ReStructuredText

====
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
.. 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 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 role(s)
.. program:: role delete
.. code:: bash
os role delete
<role> [<role> ...]
.. describe:: <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 (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
---------
Display role details
.. program:: role show
.. code:: bash
os role show
<role>
.. describe:: <role>
Role to display (name or ID)