UserMgmtStaffResourceAPI (ledgers-middleware-rest-api 2.4 API)

public interface UserMgmtStaffResourceAPI

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_PATH`
`static String`	`BRANCH`
`static String`	`PAGE`
`static String`	`QUERY_PARAM`
`static String`	`ROLES`
`static String`	`SIZE`
`static String`	`USER_CANNOT_REGISTER_IN_BRANCH`
`static String`	`USER_ID`
`static String`	`USER_NOT_IN_BRANCH`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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<CustomPageImpl<UserTO>>`	`getBranchUsersByRoles(List<UserRoleTO> roles, String queryParam, int page, int size)` Lists users within the branch and roles
`org.springframework.http.ResponseEntity<SCALoginResponseTO>`	`login(UserCredentialsTO userCredentials)` Authorize returns a bearer token that can be reused by the consuming application.
`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>`	`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
- BRANCH
```
static final String BRANCH
```
  See Also:
  
  Constant Field Values
- ROLES
```
static final String ROLES
```
  See Also:
  
  Constant Field Values
- QUERY_PARAM
```
static final String QUERY_PARAM
```
  See Also:
  
  Constant Field Values
- PAGE
```
static final String PAGE
```
  See Also:
  
  Constant Field Values
- SIZE
```
static final String SIZE
```
  See Also:
  
  Constant Field Values
- USER_ID
```
static final String USER_ID
```
  See Also:
  
  Constant Field Values
- USER_NOT_IN_BRANCH
```
static final String USER_NOT_IN_BRANCH
```
  See Also:
  
  Constant Field Values
- USER_CANNOT_REGISTER_IN_BRANCH
```
static final String USER_CANNOT_REGISTER_IN_BRANCH
```
  See Also:
  
  Constant Field Values

Method Detail

register

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

Registers a new user within a given branch.

Returns:: user object without pin

modifyUser

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

Modify a user within a given branch.

Returns:: user object without pin

login

@PostMapping(value="/login")
org.springframework.http.ResponseEntity<SCALoginResponseTO> login(@RequestBody
                                                                                               UserCredentialsTO userCredentials)

Authorize returns a bearer token that can be reused by the consuming application.

Parameters:: userCredentials - tpp login and tpp pin
Returns:: JWT token and user info

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(value="roles")
                                                                                                  List<UserRoleTO> roles,
                                                                                                  @RequestParam(value="queryParam",defaultValue="",required=false)
                                                                                                  String queryParam,
                                                                                                  @RequestParam(value="page")
                                                                                                  int page,
                                                                                                  @RequestParam(value="size")
                                                                                                  int size)

Lists users within the branch and roles

Returns:: list of users for the branch with roles

getBranchUserById

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

Gets user by ID if it's within the branch

Parameters:: userId - user ID
Returns:: user

updateUserScaData

@PostMapping(value="/{userId}/sca-data")
org.springframework.http.ResponseEntity<Void> updateUserScaData(@PathVariable(value="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(value="/access/{userId}")
org.springframework.http.ResponseEntity<Void> updateAccountAccessForUser(@PathVariable(value="userId")
                                                                                                               String userId,
                                                                                                               @RequestBody
                                                                                                               AccountAccessTO access)

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

Returns:: nothing

Interface UserMgmtStaffResourceAPI

Field Summary

Method Summary

Field Detail

BASE_PATH

BRANCH

ROLES

QUERY_PARAM

PAGE

SIZE

USER_ID

USER_NOT_IN_BRANCH

USER_CANNOT_REGISTER_IN_BRANCH