user.integration
================

.. py:module:: user.integration


Attributes
----------

.. autoapisummary::

   user.integration._AuthenticationProvider


Classes
-------

.. autoapisummary::

   user.integration.UserApp


Functions
---------

.. autoapisummary::

   user.integration.authentication_provider
   user.integration.handle_authentication
   user.integration.handle_provider_authorisation
   user.integration.handle_provider_logout
   user.integration.get_js_path
   user.integration.get_preview_widget_asset
   user.integration.auto_login_tween_factory


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

.. py:type:: _AuthenticationProvider
   :canonical: SeparateAuthenticationProvider | IntegratedAuthenticationProvider


.. py:class:: UserApp

   Bases: :py:obj:`more.webassets.WebassetsApp`


   Provides user integration.

   Historically it was not necessary to use this app for user integration,
   and most features are still possible without it. However, third-party
   authentication providers only work if the UserApp is integrated.

   The following configuration options are accepted:

   :authentication_providers:

       A dictionary of provider-specific configuration settings, see
       :mod:`onegov.user.auth.provider` for more information.



   .. py:attribute:: application_id
      :type:  str


   .. py:attribute:: auto_login_provider
      :type:  onegov.user.auth.provider.AuthenticationProvider | None


   .. py:property:: providers
      :type: collections.abc.Mapping[str, _AuthenticationProvider]


      Returns a mapping of availabe providers. 



   .. py:method:: provider(name: str) -> onegov.user.auth.provider.AuthenticationProvider | None


   .. py:method:: on_login(request: onegov.core.request.CoreRequest, user: onegov.user.User) -> None

      Called by the auth module, whenever a successful login
      was completed.




   .. py:method:: redirect_after_login(identity: morepath.Identity, request: onegov.core.request.CoreRequest, default: str) -> str | None

      Returns the path to redirect after login, given the received
      identity, the request and the default path.

      Returns a path, or None if the default path should be used.




   .. py:method:: configure_authentication_providers(**cfg: Any) -> None


.. py:function:: authentication_provider(app: UserApp, name: str, to: str = '/') -> onegov.user.auth.provider.AuthenticationProvider | None

.. py:function:: handle_authentication(self: onegov.user.auth.provider.SeparateAuthenticationProvider, request: onegov.core.request.CoreRequest) -> webob.response.Response

.. py:function:: handle_provider_authorisation(self: onegov.user.auth.provider.OauthProvider, request: onegov.core.request.CoreRequest) -> webob.response.Response

.. py:function:: handle_provider_logout(self: onegov.user.auth.provider.AuthenticationProvider, request: onegov.core.request.CoreRequest) -> webob.response.Response

   We contact the provider that the user wants to log out and redirecting
   him to our main logout view. 


.. py:function:: get_js_path() -> str

.. py:function:: get_preview_widget_asset() -> collections.abc.Iterator[str]

.. py:function:: auto_login_tween_factory(app: UserApp, handler: collections.abc.Callable[[onegov.core.request.CoreRequest], webob.response.Response]) -> collections.abc.Callable[[onegov.core.request.CoreRequest], webob.response.Response]