Package de.adorsys.ledgers.oba.rest.api.resource.oba

Interface ObaConsentApi

public interface ObaConsentApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	confirm(String userLogin, String consentId, String authorizationId, String tan)
org.springframework.http.ResponseEntity<List<ObaAisConsent>>	consents(String userLogin)
org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<ObaAisConsent>>	consentsPaged(String userLogin, int page, int size)
org.springframework.http.ResponseEntity<Void>	createPiis(CreatePiisConsentRequestTO request)
org.springframework.http.ResponseEntity<Boolean>	revokeConsent(String consentId)
org.springframework.http.ResponseEntity<List<TppInfoTO>>	tpps()

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

consents

@GetMapping(path="/{userLogin}")
org.springframework.http.ResponseEntity<List<ObaAisConsent>> consents(@PathVariable("userLogin")
                                                                      String userLogin)

Parameters:

userLogin - login of current user

Returns:

List of valid AIS Consents for user

consentsPaged

@GetMapping(path="/{userLogin}/paged")
org.springframework.http.ResponseEntity<de.adorsys.ledgers.util.domain.CustomPageImpl<ObaAisConsent>> consentsPaged(@PathVariable("userLogin")
                                                                                                                    String userLogin,
                                                                                                                    @RequestParam(required=false,defaultValue="0")
                                                                                                                    int page,
                                                                                                                    @RequestParam(required=false,defaultValue="25")
                                                                                                                    int size)

Parameters:

userLogin - login of current user

Returns:

List of valid AIS Consents for user

revokeConsent

@PutMapping(path="/{consentId}")
org.springframework.http.ResponseEntity<Boolean> revokeConsent(@PathVariable
                                                               String consentId)

Parameters:

consentId - identifier of consent

confirm

@GetMapping(path="/confirm/{userLogin}/{consentId}/{authorizationId}/{tan}")
org.springframework.http.ResponseEntity<Void> confirm(@PathVariable("userLogin")
                                                      String userLogin,
                                                      @PathVariable("consentId")
                                                      String consentId,
                                                      @PathVariable("authorizationId")
                                                      String authorizationId,
                                                      @PathVariable("tan")
                                                      String tan)

Parameters:

consentId - decrypted consent id

authorizationId - authorization id

tan - TAN for single operation

Returns:

200 OK if operation was successful, or an error with msg on the failure reason

createPiis

@PostMapping(path="/piis")
org.springframework.http.ResponseEntity<Void> createPiis(@RequestBody
                                                         CreatePiisConsentRequestTO request)

tpps

@GetMapping(path="/tpp")
org.springframework.http.ResponseEntity<List<TppInfoTO>> tpps()