magpie.cli.batch_update_users
¶
Magpie helper to create or delete a list of users using a set of input parameters.
Useful for batch operations.
Module Contents¶
Functions¶
|
|
|
|
|
Creates the users using provided configuration. |
|
Deletes the specified users. |
|
Generates the output from obtained user creation/deletion results. |
|
|
|
-
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: magpie.typedefs.Str, magpie_admin_username: magpie.typedefs.Str, magpie_admin_password: magpie.typedefs.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: magpie.typedefs.Str, magpie_admin_username: magpie.typedefs.Str, magpie_admin_password: magpie.typedefs.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.