magpie.api.management.register.register_formats
===============================================

.. py:module:: magpie.api.management.register.register_formats


Functions
---------

.. autoapisummary::

   magpie.api.management.register.register_formats.format_pending_user


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

.. py:function:: format_pending_user(user: magpie.models.UserPending, basic_info: bool = False, dotted: bool = False, container: Optional[magpie.typedefs.AnySettingsContainer] = None) -> magpie.typedefs.JSON

   Formats a :term:`Pending User` information into JSON.

   :param user: :term:`Pending User` to be formatted.
   :param basic_info:
       If ``True``, return only sufficient details to identify the :term:`Pending User` registration.
   :param dotted:
       Employ a dot (``.``) instead of underscore (``_``) to separate :term:`Pending User` from its basic information.
   :param container: application settings container used to retrieve more metadata about the :term:`Pending User`.