magpie.ui.login.views
=====================

.. py:module:: magpie.ui.login.views


Classes
-------

.. autoapisummary::

   magpie.ui.login.views.LoginViews


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

.. py:class:: LoginViews(request)

   Bases: :py:obj:`magpie.ui.utils.AdminRequests`, :py:obj:`magpie.ui.utils.BaseViews`


   Handles UI operations related to login to, logout from, or registration of user accounts.

   .. warning::
       Admin requests are applicable only when using the temporary login.
       The temporary session is handled by dispatching operations to :class:`AdminRequest`.
       Only those methods should work with elevated session to ensure that returning those views in this class
       are back to unauthenticated level access.


   .. py:method:: request_providers_json()


   .. py:method:: login()


   .. py:method:: logout()


   .. py:method:: get_group_info(group_name)


   .. py:method:: register_user()

      User self-registration form results.

      .. note::
          The template employed for this form is reused for user creation by an administrator as the fields and
          validation of inputs are essentially the same. Their actual processing is different though, as in this
          case, the user attempting registration is not yet logged nor has any administrative access.

      .. seealso::
          :meth:`magpie.ui.management.views.ManagementViews.add_user`