Magpie helper to create or delete a list of users using a set of input parameters.
Useful for batch operations.
Module Contents
Functions
format_response(response)
|
|
get_login_session(magpie_url, username, password, return_response=False)
|
|
create_users(user_config: UserConfig, magpie_url: Str, magpie_admin_username: Str, magpie_admin_password: Str, password_length: Optional[int] = None) → UserConfig
|
Creates the users using provided configuration. |
delete_users(user_config: UserConfig, magpie_url: Str, magpie_admin_username: Str, magpie_admin_password: Str, **__: Any) → UserConfig
|
Deletes the specified users. |
make_output(user_results: UserConfig, is_delete: bool, output_location: Optional[Str] = None) → None
|
Generates the output from obtained user creation/deletion results. |
make_parser() → argparse.ArgumentParser
|
|
main(args: Optional[Sequence[Str]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) → Any
|
|
-
magpie.cli.batch_update_users.UserConfig[source]
-
magpie.cli.batch_update_users.LOGGER[source]
-
magpie.cli.batch_update_users.ERROR_PARAMS = 2[source]
-
magpie.cli.batch_update_users.ERROR_EXEC = 1[source]
-
magpie.cli.batch_update_users.format_response(response)[source]
-
magpie.cli.batch_update_users.get_login_session(magpie_url, username, password, return_response=False)[source]
-
magpie.cli.batch_update_users.create_users(user_config: UserConfig, magpie_url: Str, magpie_admin_username: Str, magpie_admin_password: Str, password_length: Optional[int] = None) → UserConfig[source]
Creates the users using provided configuration.
- Returns
updated configuration with generated user-credentials.
-
magpie.cli.batch_update_users.delete_users(user_config: UserConfig, magpie_url: Str, magpie_admin_username: Str, magpie_admin_password: Str, **__: Any) → UserConfig[source]
Deletes the specified users.
- Returns
details about request success or failure for each user to be deleted.
-
magpie.cli.batch_update_users.make_output(user_results: UserConfig, is_delete: bool, output_location: Optional[Str] = None) → None[source]
Generates the output from obtained user creation/deletion results.
-
magpie.cli.batch_update_users.make_parser() → argparse.ArgumentParser[source]
-
magpie.cli.batch_update_users.main(args: Optional[Sequence[Str]] = None, parser: Optional[argparse.ArgumentParser] = None, namespace: Optional[argparse.Namespace] = None) → Any[source]
