.. _f-authfiction:

module ``mlapp.authfiction``
============================





.. inheritance-diagram:: lightmlrestapi.mlapp.authfiction


Short summary
+++++++++++++

module ``lightmlrestapi.mlapp.authfiction``

Authentification part.


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| class                                                                     | truncated documentation                                                                          |
+===========================================================================+==================================================================================================+
| :class:`AuthMiddleware <lightmlrestapi.mlapp.authfiction.AuthMiddleware>` | Authentification. The name and secret comes from a file. The file must store encrypted password. |
+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+










Methods
+++++++

+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                                | truncated documentation                                                                                                |
+=======================================================================================================================+========================================================================================================================+
| :py:meth:`__init__ <lightmlrestapi.mlapp.authfiction.AuthMiddleware.__init__>`                                        |                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_token_is_valid <lightmlrestapi.mlapp.authfiction.AuthMiddleware._token_is_valid>`                          | Decides if it is valid or not.                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`parse_auth_token_from_request <lightmlrestapi.mlapp.authfiction.AuthMiddleware.parse_auth_token_from_request>` | Parses and returns Auth token from the request header. Raises `falcon.HTTPUnauthoried exception` with proper error ... |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`process_request <lightmlrestapi.mlapp.authfiction.AuthMiddleware.process_request>`                             | Processes an authentification request.                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: lightmlrestapi.mlapp.authfiction
    :members:
    :special-members: __init__
    :show-inheritance: