public interface UserMgmtStaffResourceAPI

Field Summary

Fields
Modifier and Type Field Description

static String BASE_PATH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`org.springframework.http.ResponseEntity<Boolean>`	`changeStatus(String userId)`
`org.springframework.http.ResponseEntity<UserTO>`	`createUser(UserTO user)`	Creates new user within the same branch
`org.springframework.http.ResponseEntity<UserTO>`	`getBranchUserById(String userId)`	Gets user by ID if it's within the branch
`org.springframework.http.ResponseEntity<List<String>>`	`getBranchUserLogins()`	Get list of user logins within the branch.
`org.springframework.http.ResponseEntity<CustomPageImpl<UserTO>>`	`getBranchUsersByRoles(List<UserRoleTO> roles, String queryParam, Boolean blockedParam, int page, int size)`	Lists users within the branch and roles
`org.springframework.http.ResponseEntity<UserTO>`	`modifyUser(String branch, UserTO user)`	Modify a user within a given branch.
`org.springframework.http.ResponseEntity<UserTO>`	`register(String branch, UserTO branchStaff)`	Registers a new user within a given branch.
`org.springframework.http.ResponseEntity<Void>`	`revertDatabase(RevertRequestTO revertRequest)`
`org.springframework.http.ResponseEntity<Void>`	`updateAccountAccessForUser(String userId, AccountAccessTO access)`	Grants/Updates AccountAccess for a User for a Certain account within the branch
`org.springframework.http.ResponseEntity<Void>`	`updateUserScaData(String userId, List<ScaUserDataTO> data)`	Updates SCA Data for user if it's within the branch

Field Detail
- BASE_PATH
```
static final String BASE_PATH
```
  See Also:
  
  Constant Field Values

Method Detail

register

@PostMapping("/register")
org.springframework.http.ResponseEntity<UserTO> register(@RequestParam("branch")
                                                         String branch,
                                                         @RequestBody
                                                         UserTO branchStaff)

Registers a new user within a given branch.

Returns:: user object without pin

modifyUser

@PostMapping("/modify")
org.springframework.http.ResponseEntity<UserTO> modifyUser(@RequestParam("branch")
                                                           String branch,
                                                           @RequestBody
                                                           UserTO user)

Modify a user within a given branch.

Returns:: user object without pin

createUser

@PostMapping
org.springframework.http.ResponseEntity<UserTO> createUser(@RequestBody
                                                           UserTO user)

Creates new user within the same branch

Parameters:: user - user to be created
Returns:: created user

getBranchUsersByRoles

@GetMapping
org.springframework.http.ResponseEntity<CustomPageImpl<UserTO>> getBranchUsersByRoles(@RequestParam("roles")
                                                                                      List<UserRoleTO> roles,
                                                                                      @RequestParam(value="queryParam",defaultValue="",required=false)
                                                                                      String queryParam,
                                                                                      @RequestParam(value="blockedParam",required=false)
                                                                                      Boolean blockedParam,
                                                                                      @RequestParam("page")
                                                                                      int page,
                                                                                      @RequestParam("size")
                                                                                      int size)

Lists users within the branch and roles

Returns:: list of users for the branch with roles

getBranchUserLogins

@GetMapping("/logins")
org.springframework.http.ResponseEntity<List<String>> getBranchUserLogins()

Get list of user logins within the branch.

Returns:: list of user logins.

getBranchUserById

@GetMapping("/{userId}")
org.springframework.http.ResponseEntity<UserTO> getBranchUserById(@PathVariable("userId")
                                                                  String userId)

Gets user by ID if it's within the branch

Parameters:: userId - user ID
Returns:: user

updateUserScaData

@PostMapping("/{userId}/sca-data")
org.springframework.http.ResponseEntity<Void> updateUserScaData(@PathVariable("userId")
                                                                String userId,
                                                                @RequestBody
                                                                List<ScaUserDataTO> data)

Updates SCA Data for user if it's within the branch

Parameters:: userId - user ID; data - user SCA data
Returns:: updated user

updateAccountAccessForUser

@PutMapping("/access/{userId}")
org.springframework.http.ResponseEntity<Void> updateAccountAccessForUser(@PathVariable("userId")
                                                                         String userId,
                                                                         @RequestBody
                                                                         AccountAccessTO access)

Grants/Updates AccountAccess for a User for a Certain account within the branch

Returns:: nothing

changeStatus

@PostMapping("/{userId}/status")
org.springframework.http.ResponseEntity<Boolean> changeStatus(@PathVariable("userId")
                                                              String userId)

revertDatabase

@PostMapping("/revert")
org.springframework.http.ResponseEntity<Void> revertDatabase(@RequestBody
                                                             RevertRequestTO revertRequest)

Interface UserMgmtStaffResourceAPI

Field Summary