org.views.auth
==============

.. py:module:: org.views.auth

.. autoapi-nested-parse::

   The authentication views. 



Functions
---------

.. autoapisummary::

   org.views.auth.redirect_to_userprofile
   org.views.auth.handle_login
   org.views.auth.handle_registration
   org.views.auth.handle_activation
   org.views.auth.do_logout
   org.views.auth.do_logout_with_external_provider
   org.views.auth.view_logout
   org.views.auth.handle_password_reset_request
   org.views.auth.handle_password_reset
   org.views.auth.handle_mtan_second_factor
   org.views.auth.handle_mtan_second_factor_setup
   org.views.auth.handle_totp_second_factor
   org.views.auth.handle_request_mtan
   org.views.auth.handle_authenticate_mtan


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

.. py:function:: redirect_to_userprofile(self: onegov.user.Auth, username: str | None, request: onegov.org.request.OrgRequest) -> bool

.. py:function:: handle_login(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.LoginForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Handles the login requests. 


.. py:function:: handle_registration(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.RegistrationForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Handles the user registration. 


.. py:function:: handle_activation(self: onegov.user.Auth, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: do_logout(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, to: str | None = None) -> webob.Response

.. py:function:: do_logout_with_external_provider(self: onegov.user.Auth, request: onegov.org.request.OrgRequest) -> webob.Response

   Use this function if you want to go the way to the external auth
   provider first and then logout on redirect. 


.. py:function:: view_logout(self: onegov.user.Auth, request: onegov.org.request.OrgRequest) -> webob.Response

   Handles the logout requests 


.. py:function:: handle_password_reset_request(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.RequestPasswordResetForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Handles the GET and POST password reset requests. 


.. py:function:: handle_password_reset(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.PasswordResetForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_mtan_second_factor(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.MTANForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_mtan_second_factor_setup(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.RequestMTANForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_totp_second_factor(self: onegov.user.Auth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.TOTPForm, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_request_mtan(self: onegov.org.auth.MTANAuth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.RequestMTANForm, layout: onegov.org.layout.Layout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_authenticate_mtan(self: onegov.org.auth.MTANAuth, request: onegov.org.request.OrgRequest, form: onegov.user.forms.MTANForm, layout: onegov.org.layout.Layout | None = None) -> onegov.core.types.RenderData | webob.Response