.. _ref_django:

=======================
Public Django interface
=======================

Policies
--------

.. autoclass:: tutelary.models.Policy
   :members:

.. autoclass:: tutelary.models.Role
   :members:

.. autofunction:: tutelary.models.assign_user_policies

.. autofunction:: tutelary.models.clear_user_policies


Permissioning models
--------------------

.. autofunction:: tutelary.decorators.permissioned_model


Permissions for views
---------------------

.. autoclass:: tutelary.mixins.PermissionRequiredMixin

.. autoclass:: tutelary.mixins.APIPermissionRequiredMixin

.. autofunction:: tutelary.decorators.permission_required


Permissions backend
-------------------

.. autoclass:: tutelary.backends.Backend
   :members:


Exceptions
----------

.. autoexception:: tutelary.exceptions.EffectException

.. autoexception:: tutelary.exceptions.PatternOverlapException

.. autoexception:: tutelary.exceptions.PolicyBodyException

.. autoexception:: tutelary.exceptions.VariableSubstitutionException

.. autoexception:: tutelary.exceptions.RoleVariableException

.. autoexception:: tutelary.exceptions.DecoratorException

.. autoexception:: tutelary.exceptions.PermissionObjectException