SudoSOS Back-end API / users / UserController
Class: UserController ​
The BaseController class is responsible for:
- Storing route definitions.
- Generating router objects based on the policy.
Extends ​
Constructors ​
Constructor ​
new UserController(options, tokenHandler): UserController;Create a new user controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
tokenHandler | TokenHandler | - |
Returns ​
UserController
Overrides ​
Properties ​
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
roleManager | protected | RoleManager | A reference to the role manager passed in the base controller options. | BaseController.roleManager |
specification | public | SwaggerSpecification | A reference to the swagger specification passed in the base controller options. | BaseController.specification |
Methods ​
acceptToS() ​
acceptToS(req, res): Promise<void>;POST /users/acceptTos
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - ToS accepted
Operation Id ​
acceptTos
Tags ​
users - Operations of the User controller
Security ​
JWT
addUserRole() ​
addUserRole(req, res): Promise<void>;POST /users/{id}/roles
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Tags ​
users - Operations of user controller
Operation Id ​
addUserRole
Security ​
JWT
createUser() ​
createUser(req, res): Promise<void>;POST /users
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - New user
Operation Id ​
createUser
Tags ​
users - Operations of user controller
Security ​
JWT
deleteUser() ​
deleteUser(req, res): Promise<void>;DELETE /users/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - User successfully deleted
Operation Id ​
deleteUser
Tags ​
users - Operations of user controller
Security ​
JWT
deleteUserKey() ​
deleteUserKey(req, res): Promise<void>;Delete /users/{id}/authenticator/key
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Deletion succesfull
Operation Id ​
deleteUserKey
Tags ​
users - Operations of user controller
Security ​
JWT
deleteUserNfc() ​
deleteUserNfc(req, res): Promise<void>;DELETE /users/{id}/authenticator/nfc
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Delete nfc success
Operation Id ​
deleteUserNfc
Tags ​
users - Operations of user controller
Security ​
JWT
deleteUserRole() ​
deleteUserRole(req, res): Promise<void>;DELETE /users/{id}/roles/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Tags ​
users - Operations of user controller
Operation Id ​
deleteUserRole
Security ​
JWT
findUserNfc() ​
findUserNfc(req, res): Promise<void>;GET /users/nfc/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested user
Operation Id ​
findUserNfc
Tags ​
users - Operations of the user controller
Security ​
JWT
getAllUsers() ​
getAllUsers(req, res): Promise<void>;GET /users
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - A list of all users
Operation Id ​
getAllUsers
Tags ​
users - Operations of user controller
Security ​
JWT
getAllUsersOfUserType() ​
getAllUsersOfUserType(req, res): Promise<void>;GET /users/usertype/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - A list of all users
Operation Id ​
getAllUsersOfUserType
Tags ​
users - Operations of user controller
Security ​
JWT
getIndividualUser() ​
getIndividualUser(req, res): Promise<void>;GET /users/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Individual user
Operation Id ​
getIndividualUser
Tags ​
users - Operations of user controller
Security ​
JWT
getOrganMembers() ​
getOrganMembers(req, res): Promise<void>;GET /users/{id}/members
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All members of the organ
Operation Id ​
getOrganMembers
Tags ​
users - Operations of user controller
Security ​
JWT
getPolicy() ​
getPolicy(): Policy;Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.
Returns ​
The policy of this controller.
Overrides ​
getRecentlyChargedUsers() ​
getRecentlyChargedUsers(req, res): Promise<void>;GET /users/recently-charged
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - List of recently charged users.
Operation Id ​
getRecentlyChargedUsers
Tags ​
users - Operations of user controller
Security ​
JWT
getRouter() ​
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getUserRoles() ​
getUserRoles(req, res): Promise<void>;GET /users/{id}/roles
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The roles of the user
Operation Id ​
getUserRoles
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersContainers() ​
getUsersContainers(req, res): Promise<void>;GET /users/{id}/containers
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All users updated containers
Operation Id ​
getUsersContainers
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersFinancialMutations() ​
getUsersFinancialMutations(req, res): Promise<void>;GET /users/{id}/financialmutations
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The financial mutations of the user
Operation Id ​
getUsersFinancialMutations
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersPointsOfSale() ​
getUsersPointsOfSale(req, res): Promise<void>;GET /users/{id}/pointsofsale
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All users updated point of sales
Operation Id ​
getUsersPointsOfSale
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersProcessingDeposits() ​
getUsersProcessingDeposits(req, res): Promise<void>;GET /users/{id}/deposits
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The processing deposits of a user
Operation Id ​
getUsersProcessingDeposits
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersProducts() ​
getUsersProducts(req, res): Promise<void>;GET /users/{id}/products
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - List of products.
Operation Id ​
getUsersProducts
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersPurchaseReportPdf() ​
getUsersPurchaseReportPdf(req, res): Promise<void>;GET /users/{id}/transactions/purchases/report/pdf
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
404 - User not found error.
Operation Id ​
getUsersPurchaseReportPdf
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersPurchasesReport() ​
getUsersPurchasesReport(req, res): Promise<void>;GET /users/{id}/transactions/purchases/report
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The purchases report of the user
Operation Id ​
getUsersPurchasesReport
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersSalesReport() ​
getUsersSalesReport(req, res): Promise<void>;GET /users/{id}/transactions/sales/report
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The sales report of the user
Operation Id ​
getUsersSalesReport
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersSalesReportPdf() ​
getUsersSalesReportPdf(req, res): Promise<void>;GET /users/{id}/transactions/sales/report/pdf
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
404 - User not found error.
Operation Id ​
getUsersSalesReportPdf
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersTransactions() ​
getUsersTransactions(req, res): Promise<void>;GET /users/{id}/transactions
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - List of transactions.
Operation Id ​
getUsersTransactions
Tags ​
users - Operations of user controller
Security ​
JWT
getUsersTransactionsReport() ​
getUsersTransactionsReport(req, res): Promise<void>;GET /users/{id}/transactions/report
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The transaction report of the user
Operation Id ​
getUsersTransactionsReport
Tags ​
users - Operations of user controller
Security ​
JWT
Deprecated ​
- Use /users/{id}/transactions/sales/report or /users/{id}/transactions/purchases/report instead
getUsersTransfers() ​
getUsersTransfers(req, res): Promise<void>;GET /users/{id}/transfers
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - List of transfers.
Operation Id ​
getUsersTransfers
Tags ​
users - Operations of user controller
Security ​
JWT
updateUser() ​
updateUser(req, res): Promise<void>;PATCH /users/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - New user
Operation Id ​
updateUser
Tags ​
users - Operations of user controller
Security ​
JWT
updateUserKey() ​
updateUserKey(req, res): Promise<void>;POST /users/{id}/authenticator/key
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The new key
Operation Id ​
updateUserKey
Tags ​
users - Operations of user controller
Security ​
JWT
updateUserLocalPassword() ​
updateUserLocalPassword(req, res): Promise<void>;PUT /users/{id}/authenticator/local
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Update success
Operation Id ​
updateUserLocalPassword
Tags ​
users - Operations of user controller
Security ​
JWT
updateUserNfc() ​
updateUserNfc(req, res): Promise<void>;PUT /users/{id}/authenticator/nfc
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Update success
Operation Id ​
updateUserNfc
Tags ​
users - Operations of user controller
Security ​
JWT
updateUserPin() ​
updateUserPin(req, res): Promise<void>;PUT /users/{id}/authenticator/pin
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Update success
Operation Id ​
updateUserPin
Tags ​
users - Operations of user controller
Security ​
JWT
waiveUserFines() ​
waiveUserFines(req, res): Promise<void>;POST /users/{id}/fines/waive
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Tags ​
users - Operations of user controller
Operation Id ​
waiveUserFines
Security ​
JWT
getAttributes() ​
static getAttributes(req): string[];Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
Returns ​
string[]
getRelation() ​
static getRelation(req): string;Function to determine which credentials are needed to GET 'all' if user is not connected to User 'organ' if user is connected to User via organ 'own' if user is connected to User
Parameters ​
| Parameter | Type | Description |
|---|---|---|
req | RequestWithToken | - |
Returns ​
string
whether User is connected to used token