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 consentId, String authorisationId, OpTypeTO opType)
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<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<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)
org.springframework.http.ResponseEntity<Void>	verifyAuthConfirmationCode(String authorisationId, String authConfirmCode)

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

multilevel

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

multilevelAccounts

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

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)

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

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)

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 - user login

pin - users pin

role - users Role at Ledgers

Returns:

Login response containing a bearer token in case of success with some additional info if further SCA is required

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 - users login

pin - users pin

consentId - identifier of consent at CMS or other consent management system

authorisationId - the identifier of authorization object

opType - the type of carried operation

Returns:

ScaLoginResponse object containing information for further SCA validation if required and a valid access token

authoriseForConsent

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

validate

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

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)

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 - identifier of SCA operation at Ledgers

authorisationId - identifier of Authorization at Ledgers

scaMethodId - identifier of SCA method

Returns:

ScaLoginResponse object containing information for further SCA validation if required and an Access token

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)

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 - identifier of SCA operation at Ledgers

authorisationId - identifier of Authorization at Ledgers

authCode - a code sent to user to confirm operation

Returns:

ScaLoginResponse with a valid Access Token to fulfill the requested operation

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)

getUserById

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

getAllUsers

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

verifyAuthConfirmationCode

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