:tocdepth: 3

:py:mod:`gws.plugin.auth_provider.file`
=======================================

.. py:module:: gws.plugin.auth_provider.file

.. autoapi-nested-parse::

   Provider for the file-based authorization.

   This provider works with a local JSON file, which is expected to contain
   a list of user "records" (dicts).

   A record is required to contain fields ``login`` and ``password`` (hashed as per `gws.lib.password.encode`).

   Other fields, if given, are converted to respective `gws.User` properties.



**Source code:** :source:`gws.plugin.auth_provider.file<gws/plugin/auth_provider/file/__init__.py>`



Package Contents
----------------



.. py:class:: Config


   Bases: :py:obj:`gws.base.auth.provider.Config`

   File-based authorization provider

   .. py:attribute:: path
      :type:  gws.FilePath

      path to the users json file


.. py:class:: Object


   Bases: :py:obj:`gws.base.auth.provider.Object`

   .. py:attribute:: db
      :type:  list[dict]

   .. py:attribute:: path
      :type:  str

   .. py:method:: authenticate(method, credentials)

   .. py:method:: configure()

   .. py:method:: get_user(local_uid)

   .. py:method:: passwd(p: gws.EmptyRequest)

      Encode a password for the authorization file