:tocdepth: 3

:py:mod:`gws.base.auth.provider`
================================

.. py:module:: gws.base.auth.provider


**Source code:** :source:`gws.base.auth.provider<gws/base/auth/provider.py>`



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



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.Config`

   Auth provider config.

   .. py:attribute:: allowedMethods
      :type:  Optional[list[str]]

      allowed authorization methods


.. py:class:: Object


   Bases: :py:obj:`gws.AuthProvider`

   Authentication Provider.

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

      Authenticate a user.

      :param method: Authentication method.
      :param credentials: Credentials object.

      :returns: An authenticated User or ``None`` if authentication failed.


   .. py:method:: configure()

      Configuration hook.


   .. py:method:: serialize_user(user)

      Return a string representation of a User.

      :param user: A User object.

      :returns: A json string.


   .. py:method:: unserialize_user(data)

      Restore a User object from a serialized representation.

      :param ser: A json string.

      :returns: A User object.