auth_provider
=============

.. py:module:: auth_provider


Classes
-------

.. autoapisummary::

   auth_provider.AuthProvider


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

.. py:class:: AuthProvider

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: login() -> str
      :abstractmethod:


      Redirects to the login page of the provider.



   .. py:method:: logout() -> None
      :abstractmethod:


      Logs out the user.



   .. py:method:: get_user(token: dict) -> Optional[dict]
      :abstractmethod:


      Fetches the user profile using the provided token.



   .. py:method:: get_token() -> Optional[str]
      :abstractmethod:


      Gets the current user's access token.



   .. py:method:: handle_callback() -> Optional[str]
      :abstractmethod:


      Handles the callback and exchanges the code for a token (implemented by the provider).

      :return: Access token if successfully retrieved, else None



   .. py:method:: is_authenticated(token: str) -> bool
      :abstractmethod:


      Verifies if the user is authenticated using the token.