SudoSOS Back-end API / users

users

This is the module page of the user.

Enumerations

Enumeration	Description
TermsOfServiceStatus	-
UserType	-

Classes

Class	Description
LocalUser	-
User	Inactive (active: false): the user can only log in and top up their balance. Intended for e.g. alumni who have graduated but still have an outstanding debt.
UserController	The BaseController class is responsible for: - Storing route definitions. - Generating router objects based on the policy.
UserService	-

Interfaces

Interface	Description
AcceptTosRequest	-
AddRoleRequest	-
BaseUserRequest	-
BaseUserResponse	-
CreateUserRequest	-
InvoiceUserResponse	-
PaginatedUserResponse	-
PatchUserSettingsRequest	-
PatchUserTypeRequest	-
UpdateInvoiceUserRequest	-
UpdateUserRequest	-
UserFilterParameters	Parameters used to filter on Get Users functions.
UserResponse	-
UserSettingsResponse	-

Type Aliases

Type Alias	Description
FinancialMutationsFilterParams	-

Variables

Variable	Description
EligibleInactiveUsers	All users that have made inactive administrative costs.
LocalUserTypes	All user types that should be allowed to have a local password.
NotifyDebtUserTypes	All users that should be notified when in debt.
TOSRequired	All users that have required TOS restrictions.

Functions

Function	Description
asUserResponse	Parses a User entity to a UserResponse
parseGetFinancialMutationsFilters	-
parseGetUsersFilters	Extracts UserFilterParameters from the RequestWithToken