magpie.api.login.esgfopenid
===========================

.. py:module:: magpie.api.login.esgfopenid

.. autoapi-nested-parse::

   ESGF OpenID Providers
   ----------------------------------

   Providers which implement the `openid`_ protocol based on the appropriate `python-openid`_/`python3-openid`_ library.

   .. _openid: https://openid.net/
   .. _python-openid: https://github.com/openid/python-openid
   .. _python3-openid: https://github.com/necaris/python3-openid



Classes
-------

.. autoapisummary::

   magpie.api.login.esgfopenid.ESGFOpenID


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

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

   Bases: :py:obj:`authomatic.providers.openid.OpenID`


   ESGF - Earth System Grid Federation

   :class:`authomatic.providers.openid.OpenID` provider with a common provider url template :
   ``https://{hostname}/{provider}-idp/idp/{username}``.

   Accepts additional keyword arguments:

   :param hostname:
       The hostname of the ESGF OpenID provider. Default: localhost

   :param provider_url:
       The provider identifier url template. Default: ``https://{hostname}/{provider}-idp/idp/{username}``


   .. py:attribute:: hostname


   .. py:attribute:: provider_url