summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/role-assignment.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/role-assignment.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/role-assignment.rst')
-rw-r--r--doc/source/cli/command-objects/role-assignment.rst106
1 files changed, 106 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/role-assignment.rst b/doc/source/cli/command-objects/role-assignment.rst
new file mode 100644
index 00000000..b29f32c6
--- /dev/null
+++ b/doc/source/cli/command-objects/role-assignment.rst
@@ -0,0 +1,106 @@
+===============
+role assignment
+===============
+
+Identity v2, v3
+
+role assignment list
+--------------------
+
+List role assignments
+
+.. program:: role assignment list
+.. code:: bash
+
+ openstack role assignment list
+ [--role <role>]
+ [--role-domain <role-domain>]
+ [--user <user>]
+ [--user-domain <user-domain>]
+ [--group <group>]
+ [--group-domain <group-domain>]
+ [--domain <domain>]
+ [--project <project>]
+ [--project-domain <project-domain>]
+ [--effective]
+ [--inherited]
+ [--names]
+
+.. option:: --role <role>
+
+ Role to filter (name or ID)
+
+ .. 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)
+
+.. 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 <group>
+
+ Group to filter (name or ID)
+
+ .. 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:: --domain <domain>
+
+ Domain to filter (name or ID)
+
+ .. versionadded:: 3
+
+.. 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.
+
+ .. versionadded:: 3
+
+.. option:: --effective
+
+ Returns only effective role assignments (defaults to False)
+
+ .. versionadded:: 3
+
+.. option:: --inherited
+
+ Specifies if the role grant is inheritable to the sub projects
+
+ .. versionadded:: 3
+
+.. option:: --names
+
+ Returns role assignments with names instead of IDs
+
+.. option:: --auth-user
+
+ Returns role assignments for the authenticated user.
+
+.. option:: --auth-project
+
+ Returns role assignments for the project to which the authenticated user
+ is scoped.