diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/role-assignment.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/role.rst | 47 |
2 files changed, 54 insertions, 1 deletions
diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/command-objects/role-assignment.rst index ef1b22ee..dc970ed5 100644 --- a/doc/source/command-objects/role-assignment.rst +++ b/doc/source/command-objects/role-assignment.rst @@ -14,6 +14,7 @@ List role assignments os role assignment list [--role <role>] + [--role-domain <role-domain>] [--user <user>] [--user-domain <user-domain>] [--group <group>] @@ -31,6 +32,13 @@ List role assignments .. versionadded:: 3 +.. option:: --role-domain <role-domain> + + Domain the role belongs to (name or ID). + This can be used in case collisions between role names exist. + + .. versionadded:: 3 + .. option:: --user <user> User to filter (name or ID) diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 5542a35b..2ff1f13a 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -15,6 +15,7 @@ Add role assignment to a user or group in a project or domain os role add --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] + --role-domain <role-domain> --inherited <role> @@ -65,6 +66,13 @@ Add role assignment to a user or group in a project or domain .. versionadded:: 3 +.. option:: --role-domain <role-domain> + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + .. describe:: <role> Role to add to <project>:<user> (name or ID) @@ -79,8 +87,15 @@ Create new role os role create [--or-show] + [--domain <domain>] <name> +.. option:: --domain <domain> + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + .. option:: --or-show Return existing role @@ -101,11 +116,18 @@ Delete role(s) os role delete <role> [<role> ...] + [--domain <domain>] .. describe:: <role> Role to delete (name or ID) +.. option:: --domain <domain> + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + role list --------- @@ -123,7 +145,8 @@ List roles Filter roles by <domain> (name or ID) - (Deprecated, please use ``role assignment list`` instead) + (Deprecated if being used to list assignments in conjunction with the + ``--user <user>``, option, please use ``role assignment list`` instead) .. option:: --project <project> @@ -189,6 +212,7 @@ Remove role assignment from domain/project : user/group os role remove --domain <domain> | --project <project> [--project-domain <project-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] + --role-domain <role-domain> --inherited <role> @@ -239,6 +263,13 @@ Remove role assignment from domain/project : user/group .. versionadded:: 3 +.. option:: --role-domain <role-domain> + + Domain the role belongs to (name or ID). + This must be specified when the name of a domain specific role is used. + + .. versionadded:: 3 + .. describe:: <role> Role to remove (name or ID) @@ -255,12 +286,19 @@ Set role properties os role set [--name <name>] + [--domain <domain>] <role> .. option:: --name <name> Set role name +.. option:: --domain <domain> + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + .. describe:: <role> Role to modify (name or ID) @@ -274,8 +312,15 @@ Display role details .. code:: bash os role show + [--domain <domain>] <role> +.. option:: --domain <domain> + + Domain the role belongs to (name or ID). + + .. versionadded:: 3 + .. describe:: <role> Role to display (name or ID) |