:py:mod:`GeoHealthCheck.plugins.resourceauth.resourceauths`
===========================================================

.. py:module:: GeoHealthCheck.plugins.resourceauth.resourceauths


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

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugins.resourceauth.resourceauths.NoAuth
   GeoHealthCheck.plugins.resourceauth.resourceauths.BasicAuth
   GeoHealthCheck.plugins.resourceauth.resourceauths.BearerTokenAuth




.. py:class:: NoAuth


   Bases: :py:obj:`GeoHealthCheck.resourceauth.ResourceAuth`

   Checks if header exists and has given header value.
   See http://docs.python-requests.org/en/master/user/quickstart

   .. py:attribute:: NAME
      :value: 'None'

      

   .. py:attribute:: DESCRIPTION
      :value: 'Default class for no auth'

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:method:: verify()


   .. py:method:: encode()

      Encode/encrypt auth dict structure.
      :return: encoded string



.. py:class:: BasicAuth


   Bases: :py:obj:`GeoHealthCheck.resourceauth.ResourceAuth`

   Basic authentication.

   .. py:attribute:: NAME
      :value: 'Basic'

      

   .. py:attribute:: DESCRIPTION
      :value: 'Default class for no auth'

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:method:: verify()


   .. py:method:: encode_auth_header_val()

      Get encoded authorization header value from config data.
      Authorization scheme-specific. ::

          {
            'type': 'Basic',
            'data': {
              'username': 'the_user',
              'password': 'the_password'
            }
          }

      :return: None or http Basic auth header value



.. py:class:: BearerTokenAuth


   Bases: :py:obj:`GeoHealthCheck.resourceauth.ResourceAuth`

   Bearer token auth

   .. py:attribute:: NAME
      :value: 'Bearer Token'

      

   .. py:attribute:: DESCRIPTION
      :value: 'Bearer token auth'

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:method:: verify()


   .. py:method:: encode_auth_header_val()

      Get encoded authorization header value from config data.
      Authorization scheme-specific. ::

        {
          'type': 'Bearer Token',
          'data': {
              'token': 'the_token'
           }
        }

      :return: None or http auth header value