user.models.tan
===============

.. py:module:: user.models.tan


Attributes
----------

.. autoapisummary::

   user.models.tan.DEFAULT_EXPIRES_AFTER


Classes
-------

.. autoapisummary::

   user.models.tan.TAN


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

.. py:data:: DEFAULT_EXPIRES_AFTER

.. py:class:: TAN

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


   A single use TAN for temporarily elevating access or to serve
   as a second authentication factor through e.g. a mobile phone
   number.



   .. py:attribute:: __tablename__
      :value: 'tans'



   .. py:attribute:: __table_args__


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


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


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


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


   .. py:attribute:: expired
      :type:  sqlalchemy.Column[datetime.datetime | None]


   .. py:method:: is_active(expires_after: datetime.timedelta | None = DEFAULT_EXPIRES_AFTER) -> bool


   .. py:method:: expire() -> None