magpie.api.management.user.user_formats
=======================================

.. py:module:: magpie.api.management.user.user_formats


Functions
---------

.. autoapisummary::

   magpie.api.management.user.user_formats.format_user


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

.. py:function:: format_user(user: magpie.models.AnyUser, group_names: List[magpie.typedefs.Str] = None, basic_info: bool = False, dotted: bool = False) -> magpie.typedefs.JSON

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

   :param user: :term:`User` to be formatted.
   :param group_names:
       Override of group name listing to provide as user memberships.
       Retrieve the complete group membership listing from the :paramref:`user` if not provided.
   :param basic_info:
       If ``True``, return only sufficient details to identify the :term:`User`, without any additional group details.
   :param dotted:
       Employ a dot (``.``) instead of underscore (``_``) to separate :term:`User` from its basic information.

   .. seealso::
       :func:`magpie.api.management.group.group_formats.format_group`