Menu
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
1
Share

UserService

Functions
activate_user @classmethod
id_ : str
triggered_by : gws_core.user.user.User | None
Return type : User
create_or_update_user_dto @classmethod
user_dto : UserFullDTO
triggered_by : gws_core.user.user.User | None
Return type : User
create_sysuser @classmethod

Create the system user

deactivate_user @classmethod
id_ : str
triggered_by : gws_core.user.user.User | None
Return type : User
get_all_real_users @classmethod
Return type : list
get_all_users @classmethod
Return type : list
get_by_id_and_check @classmethod
id_ : str
Return type : User
get_by_id_or_none @classmethod
id_ : str
Return type : gws_core.user.user.User | None
get_or_import_user_info @classmethod

Get the user info from the database. If the user doesn't exist locally, try to import from the space server.

user_id : str
ID of the user to find or import.
fallback_to_sysuser : bool - False
If True, return the system user when the user cannot be found or imported (e.g. space server unreachable). Defaults to False.
Return type : User
get_sysuser @classmethod
get_user_by_email @classmethod
email : str
Return type : gws_core.user.user.User | None
get_user_by_id @classmethod
id_ : str
Return type : gws_core.user.user.User | None
set_user_active @classmethod
id_ : str
is_active : bool
triggered_by : gws_core.user.user.User | None
Return type : User
smart_search_by_name @classmethod
name : str
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
synchronize_all_space_users @classmethod
triggered_by : gws_core.user.user.User | None
user_exists @classmethod
id_ : str
Return type : bool
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.