de.adorsys.ledgers.middleware.rest.resource

Interface UserMgmtRestAPI

public interface UserMgmtRestAPI

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<SCALoginResponseTO>	authorise(String login, String pin, UserRoleTO role) Initiates the user login process.
org.springframework.http.ResponseEntity<SCALoginResponseTO>	authoriseForConsent(String login, String pin, String consentId, String authorisationId, OpTypeTO opType) Initiates the user login process.
org.springframework.http.ResponseEntity<SCALoginResponseTO>	authorizeLogin(String scaId, String authorisationId, String authCode) Send the auth code for two factor login.
org.springframework.http.ResponseEntity<List<UserTO>>	getAllUsers()
org.springframework.http.ResponseEntity<UserTO>	getUser()
org.springframework.http.ResponseEntity<UserTO>	getUserById(String userId)
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<SCALoginResponseTO>	selectMethod(String scaId, String authorisationId, String scaMethodId) Selects the scaMethod to use for sending a login transaction number to the user.
org.springframework.http.ResponseEntity<Void>	updateUserScaData(List<ScaUserDataTO> data)
org.springframework.http.ResponseEntity<BearerTokenTO>	validate(String token)

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

register

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

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 -

email -

pin -

role -

Returns:

Throws:

ConflictRestException

authorise

@PostMapping(value="/login")
org.springframework.http.ResponseEntity<SCALoginResponseTO> authorise(@RequestParam(value="login")
                                                                                                   String login,
                                                                                                   @RequestParam(value="pin")
                                                                                                   String pin,
                                                                                                   @RequestParam(value="role")
                                                                                                   UserRoleTO role)
                                                                                            throws NotFoundRestException,
                                                                                                   ForbiddenRestException

Initiates the user login process. Returns a login response object describing how to proceed. This response object contains an scaId that must be used to proceed with the login. if the SCAResponseTO.getScaStatus() equals ScaStatusTO.EXEMPTED the response will contain the final bearer token. ScaStatusTO.SCAMETHODSELECTED means the auth code has been sent to the user. Must be entered by the user. ScaStatusTO.PSUAUTHENTICATED there will be a list of scaMethods for selection in the response. ScaStatusTO.PSUIDENTIFIED the user exists but given password/pin did not match.

Parameters:

login -

pin -

role -

Returns:

Throws:

NotFoundRestException

ForbiddenRestException - : role specified by the user did not match

authoriseForConsent

@PostMapping(value="/loginForConsent")
org.springframework.http.ResponseEntity<SCALoginResponseTO> authoriseForConsent(@RequestParam(value="login")
                                                                                                                       String login,
                                                                                                                       @RequestParam(value="pin")
                                                                                                                       String pin,
                                                                                                                       @RequestParam(value="consentId")
                                                                                                                       String consentId,
                                                                                                                       @RequestParam(value="authorisationId")
                                                                                                                       String authorisationId,
                                                                                                                       @RequestParam(value="opType")
                                                                                                                       OpTypeTO opType)

Initiates the user login process. Returns a login response object describing how to proceed. This response object contains an scaId that must be used to proceed with the login. if the SCAResponseTO.getScaStatus() equals ScaStatusTO.EXEMPTED the response will contain the final bearer token. ScaStatusTO.SCAMETHODSELECTED means the auth code has been sent to the user. Must be entered by the user. ScaStatusTO.PSUAUTHENTICATED there will be a list of scaMethods for selection in the response. ScaStatusTO.PSUIDENTIFIED the user exists but given password/pin did not match.

Parameters:

login -

pin -

consentId -

authorisationId -

opType -

Returns:

Throws:

NotFoundRestException

ForbiddenRestException - : role specified by the user did not match

validate

@PostMapping(value="/validate")
org.springframework.http.ResponseEntity<BearerTokenTO> validate(@RequestParam(value="accessToken")
                                                                                                String token)
                                                                                         throws ForbiddenRestException

Throws:

ForbiddenRestException

selectMethod

@PutMapping(value="/{scaId}/authorisations/{authorisationId}/scaMethods/{scaMethodId}")
org.springframework.http.ResponseEntity<SCALoginResponseTO> selectMethod(@PathVariable(name="scaId")
                                                                                                                                                                 String scaId,
                                                                                                                                                                 @PathVariable(value="authorisationId")
                                                                                                                                                                 String authorisationId,
                                                                                                                                                                 @PathVariable(value="scaMethodId")
                                                                                                                                                                 String scaMethodId)
                                                                                                                                                          throws ValidationRestException,
                                                                                                                                                                 NotAcceptableRestException,
                                                                                                                                                                 NotFoundRestException,
                                                                                                                                                                 ForbiddenRestException

Selects the scaMethod to use for sending a login transaction number to the user. This is only valid for the login. The authorization id is used for the identification an authorization process. Result must be ScaStatusTO.SCAMETHODSELECTED means the auth code has been sent to the user. Must be entered by the user.

Parameters:

scaId -

authorisationId -

scaMethodId -

Returns:

Throws:

ValidationRestException

NotAcceptableRestException

NotFoundRestException

ForbiddenRestException

authorizeLogin

@PutMapping(value="/{scaId}/authorisations/{authorisationId}/authCode")
org.springframework.http.ResponseEntity<SCALoginResponseTO> authorizeLogin(@PathVariable(value="scaId")
                                                                                                                                                   String scaId,
                                                                                                                                                   @PathVariable(value="authorisationId")
                                                                                                                                                   String authorisationId,
                                                                                                                                                   @RequestParam(name="authCode")
                                                                                                                                                   String authCode)
                                                                                                                                            throws GoneRestException,
                                                                                                                                                   NotFoundRestException,
                                                                                                                                                   ExpectationFailedRestException,
                                                                                                                                                   NotAcceptableRestException,
                                                                                                                                                   ForbiddenRestException

Send the auth code for two factor login. The returned response contains a bearer token that can be used to authenticate further operations.

Parameters:

scaId -

authorisationId -

authCode -

Returns:

Throws:

GoneRestException

NotFoundRestException

ConflictRestException

ExpectationFailedRestException

NotAcceptableRestException

ForbiddenRestException

getUser

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

updateUserScaData

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

Throws:

NotFoundRestException

getUserById

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

Throws:

NotFoundRestException

getAllUsers

@GetMapping
org.springframework.http.ResponseEntity<List<UserTO>> getAllUsers()