diff --git a/doc/source/command-objects/role_assignment.rst b/doc/source/command-objects/role_assignment.rst new file mode 100644 index 0000000000..749d883e54 --- /dev/null +++ b/doc/source/command-objects/role_assignment.rst @@ -0,0 +1,45 @@ +=============== +role assignment +=============== + +Identity v3 + +role assignment list +-------------------- + +List role assignments + +.. program:: role assignment list +.. code:: bash + + os role assignment list + [--role ] + [--user ] + [--group ] + [--domain ] + [--project ] + [--effective] + +.. option:: --role + + Role to filter (name or ID) + +.. option:: --user + + User to filter (name or ID) + +.. option:: --group + + Group to filter (name or ID) + +.. option:: --domain + + Domain to filter (name or ID) + +.. option:: --project + + Project to filter (name or ID) + +.. option:: --effective + + Returns only effective role assignments (defaults to False) diff --git a/openstackclient/identity/v3/role_assignment.py b/openstackclient/identity/v3/role_assignment.py index 5cc97e8d0f..f053b608c5 100644 --- a/openstackclient/identity/v3/role_assignment.py +++ b/openstackclient/identity/v3/role_assignment.py @@ -21,7 +21,7 @@ from openstackclient.common import utils class ListRoleAssignment(lister.Lister): - """Lists role assignments according to the given filters""" + """List role assignments""" log = logging.getLogger(__name__ + '.ListRoleAssignment') @@ -36,29 +36,29 @@ class ListRoleAssignment(lister.Lister): parser.add_argument( '--role', metavar='', - help='Name or ID of role to filter', + help='Role to filter (name or ID)', ) user_or_group = parser.add_mutually_exclusive_group() user_or_group.add_argument( '--user', metavar='', - help='Name or ID of user to filter', + help='User to filter (name or ID)', ) user_or_group.add_argument( '--group', metavar='', - help='Name or ID of group to filter', + help='Group to filter (name or ID)', ) domain_or_project = parser.add_mutually_exclusive_group() domain_or_project.add_argument( '--domain', metavar='', - help='Name or ID of domain to filter', + help='Domain to filter (name or ID)', ) domain_or_project.add_argument( '--project', metavar='', - help='Name or ID of project to filter', + help='Project to filter (name or ID)', ) return parser