SudoSOS Back-end API / internal/controllers / SyncController
Class: SyncController ​
Sync controller for handling user synchronization operations. Provides endpoints for dry-run sync operations to preview changes without applying them.
Extends ​
Constructors ​
Constructor ​
new SyncController(options): SyncController;Creates a new sync controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
SyncController
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 ​
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 ​
getRouter() ​
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getUserSyncResults() ​
getUserSyncResults(req, res): Promise<void>;GET /sync/user
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Dry-run sync results
Description ​
Performs a dry-run synchronization of users using the specified services. This endpoint always performs a dry-run and does not apply any actual database changes.
Operation Id ​
getUserSyncResults
Tags ​
sync - Operations of the sync controller
Security ​
JWT