summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/role.rst
diff options
context:
space:
mode:
authorHenry Nash <henryn@linux.vnet.ibm.com>2016-02-23 11:42:40 +0000
committerSteve Martinelli <s.martinelli@gmail.com>2016-08-10 20:32:55 +0000
commit5eb7e626b18b033f97f3cf10f2791529f9d75789 (patch)
tree1b371a8835abe4dfbf82dbc8003a08621138bb5b /doc/source/command-objects/role.rst
parent0b91368164acc596bf97fe4073083e26892f5b1a (diff)
downloadpython-openstackclient-5eb7e626b18b033f97f3cf10f2791529f9d75789.tar.gz
Add support for domain specific roles
A role entity can now be specified as domain specific. Closes-bug: #1606105 Change-Id: I564cf3da1d61f5bfcf85be591480d2f5c8d694a0
Diffstat (limited to 'doc/source/command-objects/role.rst')
-rw-r--r--doc/source/command-objects/role.rst47
1 files changed, 46 insertions, 1 deletions
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)