openstack/python-openstackclient
Code Issues Proposed changes
bf32cdf3a9
python-openstackclient/doc/source/cli/command-objects/role-assignment.rst

107 lines
2.2 KiB
ReStructuredText
Raw Normal View History

add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
===============
role assignment
===============
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
Identity v2, v3
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
role assignment list
--------------------
List role assignments
.. program:: role assignment list
.. code:: bash
change os in command example to openstack(2) In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
2016-12-20 09:18:55 +08:00
openstack role assignment list
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
[--role <role>]
Add support for domain specific roles A role entity can now be specified as domain specific. Closes-bug: #1606105 Change-Id: I564cf3da1d61f5bfcf85be591480d2f5c8d694a0
2016-02-23 11:42:40 +00:00
[--role-domain <role-domain>]
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
[--user <user>]
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
[--user-domain <user-domain>]
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
[--group <group>]
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
[--group-domain <group-domain>]
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
[--domain <domain>]
[--project <project>]
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
[--project-domain <project-domain>]
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
[--effective]
Add support to inherited project role grant calls Once inherited project role grant calls are implemented on python-keystoneclient, python-openstackclient also should support such calls. This patch add such support as well as its related tests. Co-Authored-By: Raildo Mascena <raildo@lsd.ufcg.edu.br> Change-Id: Id72670be8640e5c6e2490a6ef849e9ec3493b1a9 Implements: blueprint hierarchical-multitenancy
2014-09-19 12:29:39 -03:00
[--inherited]
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
[--names]
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --role <role>
Role to filter (name or ID)
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
Add support for domain specific roles A role entity can now be specified as domain specific. Closes-bug: #1606105 Change-Id: I564cf3da1d61f5bfcf85be591480d2f5c8d694a0
2016-02-23 11:42:40 +00:00
.. 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
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --user <user>
User to filter (name or ID)
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
.. option:: --user-domain <user-domain>
Domain the user belongs to (name or ID).
This can be used in case collisions between user names exist.
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --group <group>
Group to filter (name or ID)
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
.. option:: --group-domain <group-domain>
Domain the group belongs to (name or ID).
This can be used in case collisions between group names exist.
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --domain <domain>
Domain to filter (name or ID)
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --project <project>
Project to filter (name or ID)
Add domain scoping in 'role assignment list' Add ability to set which domain the user, group or project belong to. Change-Id: Idf6c7f23ab96261a73682226fb10ce5f0133924e Closes-Bug: #1472909
2015-07-31 18:56:34 -07:00
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
add doc for role assignment command Change-Id: I594d444b6d1ec4e72bed03394178293737f26069
2014-12-23 11:43:02 +08:00
.. option:: --effective
Returns only effective role assignments (defaults to False)
Add support to inherited project role grant calls Once inherited project role grant calls are implemented on python-keystoneclient, python-openstackclient also should support such calls. This patch add such support as well as its related tests. Co-Authored-By: Raildo Mascena <raildo@lsd.ufcg.edu.br> Change-Id: Id72670be8640e5c6e2490a6ef849e9ec3493b1a9 Implements: blueprint hierarchical-multitenancy
2014-09-19 12:29:39 -03:00
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
Add support to inherited project role grant calls Once inherited project role grant calls are implemented on python-keystoneclient, python-openstackclient also should support such calls. This patch add such support as well as its related tests. Co-Authored-By: Raildo Mascena <raildo@lsd.ufcg.edu.br> Change-Id: Id72670be8640e5c6e2490a6ef849e9ec3493b1a9 Implements: blueprint hierarchical-multitenancy
2014-09-19 12:29:39 -03:00
.. option:: --inherited
Specifies if the role grant is inheritable to the sub projects
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
2015-12-09 10:08:16 -06:00
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. versionadded:: 3
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
2015-12-09 10:08:16 -06:00
.. option:: --names
Returns role assignments with names instead of IDs
Add assignment list to v2 identity and deprecate alternate listing The current identity role list command (both v2 and v3) is overloaded with listing roles as well as assignments (if you provide user, group, project or domain options). This is in addition to the v3 assignment list command designed for this purpose. This overloading complicates the fact that roles can now be domain specific (i.e. have a domain attribute), so the command 'role list --domain <domain-name' will soon become ambigious (this is in a follow on patch). This patch: - Adds a v2 assignments list, with support for pulling the user and project from the auth credentials - For comapability, adds the same auth support to the existing v3 assignments list - Deprecates the use of role list and user role list to list assignments Change-Id: I65bafdef4f8c89e863dab101369d0d629fa818b8 Partial-Bug: 1605774
2016-04-29 23:59:27 +01:00
.. 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.
Copy Permalink