magpie.api.management.user.user_formats
¶
Module Contents¶
Functions¶
|
Formats a User information into JSON. |
-
magpie.api.management.user.user_formats.
format_user
(user, group_names=None, basic_info=False, dotted=False)[source]¶ Formats a User information into JSON.
- Parameters
user – User to be formatted.
group_names – Override of group name listing to provide as user memberships. Retrieve the complete group membership listing from the
user
if not provided.basic_info – If
True
, return only sufficient details to identify the User, without any additional group details.dotted – Employ a dot (
.
) instead of underscore (_
) to separate User from its basic information.