Merge "Cleaning up policy documentation"
This commit is contained in:
commit
d54570a002
@ -96,7 +96,6 @@ In-depth documentation for Horizon and its APIs.
|
|||||||
ref/decorators
|
ref/decorators
|
||||||
ref/exceptions
|
ref/exceptions
|
||||||
ref/test
|
ref/test
|
||||||
ref/policy
|
|
||||||
|
|
||||||
Source Code Reference
|
Source Code Reference
|
||||||
---------------------
|
---------------------
|
||||||
|
@ -88,7 +88,7 @@ definition of table actions. When implementing a derived action class,
|
|||||||
setting the :attr:`~horizon.tables.Action.policy_rules` attribute to valid
|
setting the :attr:`~horizon.tables.Action.policy_rules` attribute to valid
|
||||||
policy rules will force a policy check before the
|
policy rules will force a policy check before the
|
||||||
:meth:`horizon.tables.Action.allowed` method is called on the action. These
|
:meth:`horizon.tables.Action.allowed` method is called on the action. These
|
||||||
rules are defined in the the policy files point to by ``POLICY_PATH`` and
|
rules are defined in the policy files pointed to by ``POLICY_PATH`` and
|
||||||
``POLICY_FILES``. The rules are role based, where entity owner is also a
|
``POLICY_FILES``. The rules are role based, where entity owner is also a
|
||||||
role. The format for the ``policy_rules`` is a list of two item tuples. The
|
role. The format for the ``policy_rules`` is a list of two item tuples. The
|
||||||
first component of the tuple is the scope of the policy rule, this is the
|
first component of the tuple is the scope of the policy rule, this is the
|
||||||
@ -110,7 +110,15 @@ The secondary way to add a role based check is to directly use the
|
|||||||
of actions, same format as the :attr:`~horizon.tables.Action.policy_rules`
|
of actions, same format as the :attr:`~horizon.tables.Action.policy_rules`
|
||||||
attribute detailed above; the current request object; and a dictionary of
|
attribute detailed above; the current request object; and a dictionary of
|
||||||
action targets. This is the method that :class:`horizon.tables.Action` class
|
action targets. This is the method that :class:`horizon.tables.Action` class
|
||||||
utilizes.
|
utilizes. Examples look like::
|
||||||
|
|
||||||
|
from openstack_dashboard import policy
|
||||||
|
|
||||||
|
allowed = policy.check((("identity", "identity:get_user"),
|
||||||
|
("identity", "identity:get_project"),), request)
|
||||||
|
|
||||||
|
can_see = policy.check((("identity", "identity:get_user"),), request,
|
||||||
|
target={"domain_id": domainId})
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user