components.user.api

The API contains the available function to access, create and edit a user

components.user.api.create_and_save_user(username, password, first_name, last_name, email)

Save a user with the given parameters.

Parameters:

• username (str) – Given user name
• password (str) – Given password
• first_name (str) – Given first name
• last_name (str) – Given last name
• email (str) – Given email

Returns:

User object

components.user.api.get_all_users()

Return all Users.

Returns:List of Users

components.user.api.get_all_users_by_list_id(list_user_ids)

Get all users by the given list of user ids.

Parameters:list_user_ids –

Returns:

components.user.api.get_all_users_except_list(list_user)

Get all users except the given list of users.

Parameters:list_user –

Returns:

components.user.api.get_all_users_except_list_id(list_user_ids)

Get all users except the given list of user ids.

Parameters:list_user_ids –

Returns:

components.user.api.get_id_username_dict(list_user)

Get a usable key-value list

Parameters:list_user –

Returns:

components.user.api.get_user_by_id(user_id)

Return a user given its primary key.

Parameters:user_id (str) – Given user id Returns:User object

components.user.api.get_user_by_username(username)

Return a user given its username.

Parameters:username (str) – Given username Returns:User object

components.user.api.upsert(user)

Upsert user.

Parameters:user (User) – The user to be saved

Returns: