magpie.cli.batch_update_users
=============================

.. py:module:: magpie.cli.batch_update_users

.. autoapi-nested-parse::

   Magpie helper to create or delete a list of users using a set of input parameters.

   Useful for batch operations.



Attributes
----------

.. autoapisummary::

   magpie.cli.batch_update_users.UserConfig
   magpie.cli.batch_update_users.LOGGER
   magpie.cli.batch_update_users.ERROR_PARAMS
   magpie.cli.batch_update_users.ERROR_EXEC


Functions
---------

.. autoapisummary::

   magpie.cli.batch_update_users.format_response
   magpie.cli.batch_update_users.get_login_session
   magpie.cli.batch_update_users.create_users
   magpie.cli.batch_update_users.delete_users
   magpie.cli.batch_update_users.make_output
   magpie.cli.batch_update_users.make_parser
   magpie.cli.batch_update_users.main


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

.. py:data:: UserConfig

.. py:data:: LOGGER

.. py:data:: ERROR_PARAMS
   :value: 2


.. py:data:: ERROR_EXEC
   :value: 1


.. py:function:: format_response(response)

.. py:function:: get_login_session(magpie_url, username, password, return_response=False)

.. py:function:: create_users(user_config: UserConfig, magpie_url: magpie.typedefs.Str, magpie_admin_username: magpie.typedefs.Str, magpie_admin_password: magpie.typedefs.Str, password_length: Optional[int] = None) -> UserConfig

   Creates the users using provided configuration.

   :returns: updated configuration with generated user-credentials.


.. py:function:: delete_users(user_config: UserConfig, magpie_url: magpie.typedefs.Str, magpie_admin_username: magpie.typedefs.Str, magpie_admin_password: magpie.typedefs.Str, **__: Any) -> UserConfig

   Deletes the specified users.

   :returns: details about request success or failure for each user to be deleted.


.. py:function:: make_output(user_results: UserConfig, is_delete: bool, output_location: Optional[magpie.typedefs.Str] = None) -> None

   Generates the output from obtained user creation/deletion results.


.. py:function:: make_parser() -> argparse.ArgumentParser

.. py:function:: main(args: Optional[Sequence[magpie.typedefs.Str]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) -> Any