core.security.roles
===================

.. py:module:: core.security.roles


Functions
---------

.. autoapisummary::

   core.security.roles.get_roles_setting


Module Contents
---------------

.. py:function:: get_roles_setting() -> dict[str, set[type[core.security.permissions.Intent]]]

   Returns the default roles available to onegov.core applications.

   Applications building on onegov.core may add more roles and permissions,
   or replace the existing ones entirely, though it's not something that
   one should do carelessly.

   The default roles are:

   **admin**
       Has access to everything

   **editor**
       Has access to most things

   **member**
       Has access their own data. Be careful though, core doesn't know about
       personal data, so this is just a role to implement registered users.
       As with all permissions, making sure the right information is shown
       is up to the applications.

   **anonymous**
       Has access to public things