python-openstackclient/doc/source/command-objects/role-assignment.rst
Tom Cocozzello 3a48989eb0 Return names in list role assignments
Utilize the new include names functionality added to
list role assignments (GET /role_assignments?include_names=True).
Which will return the names of the entities instead of their
IDs.

Change-Id: I6dc03baf61ef9354a8a259a9f17ff47ce1665ce7
Depends-On: I4aa77c08660a0cbd021502155938a46121ca76ef
Closes-Bug: #1479569
Implements: blueprint list-assignment-with-names
2016-01-27 18:13:32 +00:00

73 lines
1.5 KiB
ReStructuredText

===============
role assignment
===============
Identity v3
role assignment list
--------------------
List role assignments
.. program:: role assignment list
.. code:: bash
os role assignment list
[--role <role>]
[--user <user>]
[--user-domain <user-domain>]
[--group <group>]
[--group-domain <group-domain>]
[--domain <domain>]
[--project <project>]
[--project-domain <project-domain>]
[--effective]
[--inherited]
.. option:: --role <role>
Role to filter (name or ID)
.. option:: --user <user>
User to filter (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.
.. option:: --group <group>
Group to filter (name or ID)
.. option:: --group-domain <group-domain>
Domain the group belongs to (name or ID).
This can be used in case collisions between group names exist.
.. option:: --domain <domain>
Domain to filter (name or ID)
.. option:: --project <project>
Project to filter (name or ID)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. option:: --effective
Returns only effective role assignments (defaults to False)
.. option:: --inherited
Specifies if the role grant is inheritable to the sub projects
.. option:: --names
Returns role assignments with names instead of IDs