app.users
=========

.. py:module:: app.users


Attributes
----------

.. autoapisummary::

   app.users.SECRET
   app.users.bearer_transport
   app.users.auth_backend
   app.users.fastapi_users
   app.users.current_active_user
   app.users.router


Classes
-------

.. autoapisummary::

   app.users.UserManager


Functions
---------

.. autoapisummary::

   app.users.get_user_manager
   app.users.get_jwt_strategy
   app.users.register
   app.users.login


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

.. py:data:: SECRET

.. py:class:: UserManager(user_db: fastapi_users.db.BaseUserDatabase[fastapi_users.models.UP, fastapi_users.models.ID], password_helper: fastapi_users.password.PasswordHelperProtocol | None = None)

   Bases: :py:obj:`fastapi_users.UUIDIDMixin`, :py:obj:`fastapi_users.BaseUserManager`\ [\ :py:obj:`app.db.User`\ , :py:obj:`uuid.UUID`\ ]


   Mixin for parsing and validating Id of type UUID.


   .. py:attribute:: reset_password_token_secret


   .. py:attribute:: verification_token_secret


   .. py:method:: on_after_register(user: app.db.User, request: Optional[fastapi.Request] = None)
      :async:


      Perform logic after successful user registration.

      *You should overload this method to add your own logic.*

      :param user: The registered user
      :param request: Optional FastAPI request that
      triggered the operation, defaults to None.



   .. py:method:: on_after_forgot_password(user: app.db.User, token: str, request: Optional[fastapi.Request] = None)
      :async:


      Perform logic after successful forgot password request.

      *You should overload this method to add your own logic.*

      :param user: The user that forgot its password.
      :param token: The forgot password token.
      :param request: Optional FastAPI request that
      triggered the operation, defaults to None.



   .. py:method:: on_after_request_verify(user: app.db.User, token: str, request: Optional[fastapi.Request] = None)
      :async:


      Perform logic after successful verification request.

      *You should overload this method to add your own logic.*

      :param user: The user to verify.
      :param token: The verification token.
      :param request: Optional FastAPI request that
      triggered the operation, defaults to None.



.. py:function:: get_user_manager(user_db: fastapi_users.db.SQLAlchemyUserDatabase = Depends(get_user_db))
   :async:


.. py:data:: bearer_transport

.. py:function:: get_jwt_strategy() -> fastapi_users.authentication.JWTStrategy[fastapi_users.models.UP, fastapi_users.models.ID]

.. py:data:: auth_backend

.. py:data:: fastapi_users

.. py:data:: current_active_user

.. py:data:: router

.. py:function:: register(request: fastapi.Request)
   :async:


.. py:function:: login(request: fastapi.Request)
   :async: