user.models.role_mapping
========================

.. py:module:: user.models.role_mapping


Classes
-------

.. autoapisummary::

   user.models.role_mapping.RoleMapping


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

.. py:class:: RoleMapping

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Defines a generic role mapping between user and/or group and any
   other model (content).

   The model does not define the relationship to the content. Instead, the
   realtionship should be defined in the content model when needed::

       role_mappings = relationship(
           RoleMapping,
           primaryjoin=(
               "and_("
               "foreign(RoleMapping.content_id) == cast(MyModel.id, TEXT),"
               "RoleMapping.content_type == 'my_models'"
               ")"
           ),
           viewonly=True
       )



   .. py:attribute:: __tablename__
      :value: 'role_mappings'



   .. py:attribute:: type
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: __mapper_args__


   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: role
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: group_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: group
      :type:  sqlalchemy.orm.relationship[onegov.user.models.group.UserGroup | None]


   .. py:attribute:: username
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: user
      :type:  sqlalchemy.orm.relationship[onegov.user.models.user.User | None]


   .. py:attribute:: content_id
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: content_type
      :type:  sqlalchemy.Column[str]