Package de.adorsys.ledgers.middleware.rest.resource

Interface UserMgmtRestAPI

public interface UserMgmtRestAPI

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<AuthConfirmationTO>	completeAuthConfirmation(String authorisationId, boolean authCodeConfirmed)
org.springframework.http.ResponseEntity<Void>	editSelf(UserTO user)
org.springframework.http.ResponseEntity<UserTO>	getUser()
org.springframework.http.ResponseEntity<UserTO>	getUserById(String userId)
org.springframework.http.ResponseEntity<Boolean>	multilevel(String login, String iban)
org.springframework.http.ResponseEntity<Boolean>	multilevelAccounts(String login, List<AccountReferenceTO> references)
org.springframework.http.ResponseEntity<UserTO>	register(String login, String email, String pin, UserRoleTO role)	Registers a new user with the system.
org.springframework.http.ResponseEntity<Void>	resetPasswordViaEmail(String login)
org.springframework.http.ResponseEntity<Void>	updateUserScaData(List<ScaUserDataTO> data)
org.springframework.http.ResponseEntity<AuthConfirmationTO>	verifyAuthConfirmationCode(String authorisationId, String authConfirmCode)

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

multilevel

@GetMapping("/multilevel")
org.springframework.http.ResponseEntity<Boolean> multilevel(@RequestParam("login")
                                                            String login,
                                                            @RequestParam("ibanParam")
                                                            String iban)

multilevelAccounts

@PostMapping("/multilevel")
org.springframework.http.ResponseEntity<Boolean> multilevelAccounts(@RequestParam("login")
                                                                    String login,
                                                                    @RequestBody
                                                                    List<AccountReferenceTO> references)

register

@PostMapping("/register")
org.springframework.http.ResponseEntity<UserTO> register(@RequestParam("login")
                                                         String login,
                                                         @RequestParam("email")
                                                         String email,
                                                         @RequestParam("pin")
                                                         String pin,
                                                         @RequestParam(name="role",defaultValue="CUSTOMER")
                                                         UserRoleTO role)

Registers a new user with the system. Activation is dependent on the user role. - A Customer will be automatically activated. - For all other roles, explicite activation is required.

Parameters:

login - user login

email - users e-mail address

pin - users pin

role - users Role at Ledgers

Returns:

User object with erased pin

getUser

@GetMapping("/me")
org.springframework.http.ResponseEntity<UserTO> getUser()

editSelf

@PutMapping("/me")
org.springframework.http.ResponseEntity<Void> editSelf(@RequestBody
                                                       UserTO user)

updateUserScaData

@PutMapping("/sca-data")
org.springframework.http.ResponseEntity<Void> updateUserScaData(@RequestBody
                                                                List<ScaUserDataTO> data)

getUserById

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

verifyAuthConfirmationCode

@PutMapping("/authorisations/{authorisationId}/confirmation/{authConfirmCode}")
org.springframework.http.ResponseEntity<AuthConfirmationTO> verifyAuthConfirmationCode(@PathVariable("authorisationId")
                                                                                       String authorisationId,
                                                                                       @PathVariable(name="authConfirmCode")
                                                                                       String authConfirmCode)

completeAuthConfirmation

@PutMapping("/authorisations/{authorisationId}/confirmation")
org.springframework.http.ResponseEntity<AuthConfirmationTO> completeAuthConfirmation(@PathVariable("authorisationId")
                                                                                     String authorisationId,
                                                                                     @RequestParam(value="authCodeConfirmed",defaultValue="false")
                                                                                     boolean authCodeConfirmed)

resetPasswordViaEmail

@PostMapping("/reset/password/{login}")
org.springframework.http.ResponseEntity<Void> resetPasswordViaEmail(@PathVariable("login")
                                                                    String login)