:tocdepth: 3

:py:mod:`gws.plugin.auth_method.token`
======================================

.. py:module:: gws.plugin.auth_method.token

.. autoapi-nested-parse::

   HTTP Token authorisation method.

   The token authorization works by passing a token in an HTTP header.
   For example, with this configuration::

       auth.methods+ {
           type "token"
           header "X-My-Auth"
           prefix "Bearer"

       }

   the application would expect a header like ``X-My-Auth: Bearer <token>``, extract the token value
   and pass it along to authorization providers.



**Source code:** :source:`gws.plugin.auth_method.token<gws/plugin/auth_method/token/__init__.py>`



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



.. py:class:: Config


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

   HTTP-token authorization options (added in 8.1)

   .. py:attribute:: header
      :type:  str

      HTTP header name.

   .. py:attribute:: prefix
      :type:  str
      :value: ''


      Token prefix.


.. py:class:: Object


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

   .. py:attribute:: header
      :type:  str

   .. py:attribute:: prefix
      :type:  str

   .. py:method:: close_session(req, res)

   .. py:method:: configure()

   .. py:method:: open_session(req)