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

.. py:module:: GeoHealthCheck.resourceauth


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

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.resourceauth.ResourceAuth




Attributes
~~~~~~~~~~

.. autoapisummary::

   GeoHealthCheck.resourceauth.APP
   GeoHealthCheck.resourceauth.LOGGER


.. py:data:: APP

   

.. py:data:: LOGGER

   

.. py:class:: ResourceAuth


   Bases: :py:obj:`plugin.Plugin`

   Base class for specific Plugin implementations to perform
   authentication on a Resource. Subclasses provide specific
   auth methods like Basic Auth, Bearer Token etc.

   .. py:method:: init(auth_dict=None)

      Initialize ResourceAuth with related Resource and auth dict.
      :return:


   .. py:method:: create(auth_dict)
      :staticmethod:


   .. py:method:: get_auth_defs()
      :staticmethod:

      Get available ResourceAuth definitions.
      :return: dict keyed by NAME with object instance values


   .. py:method:: verify()


   .. py:method:: encode()

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


   .. py:method:: decode(encoded)
      :staticmethod:

      Decode/decrypt encrypted string into auth dict.
      :return: encoded auth dict


   .. py:method:: add_auth_header(headers_dict)


   .. py:method:: get_auth_header()

      Get encoded authorization header value from config data.
      Authorization scheme-specific.
      :return: None or dict with http auth header


   .. py:method:: encode_auth_header_val()