de.adorsys.ledgers.middleware.rest.resource

Interface ConsentRestAPI

public interface ConsentRestAPI

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<SCAConsentResponseTO>	authorizeConsent(String consentId, String authorisationId, String authCode)
org.springframework.http.ResponseEntity<SCAConsentResponseTO>	getSCA(String consentId, String authorisationId)
org.springframework.http.ResponseEntity<SCAConsentResponseTO>	grantPIISConsent(AisConsentTO piisConsent)
org.springframework.http.ResponseEntity<SCAConsentResponseTO>	selectMethod(String consentId, String authorisationId, String scaMethodId)
org.springframework.http.ResponseEntity<SCAConsentResponseTO>	startSCA(String consentId, AisConsentTO aisConsent) Initiates an sca process.

Field Detail

BASE_PATH

static final String BASE_PATH

See Also:

Constant Field Values

Method Detail

startSCA

@PostMapping(value="/{consentId}/authorisations")
org.springframework.http.ResponseEntity<SCAConsentResponseTO> startSCA(@PathVariable(value="consentId")
                                                                                                                         String consentId,
                                                                                                                         @RequestBody
                                                                                                                         AisConsentTO aisConsent)
                                                                                                                  throws ForbiddenRestException

Initiates an sca process. The result of this initiation is the user's authorization id.

Parameters:

consentId - : identifies the sca id among the users from which authorization is expected.

aisConsent - : The ais consent target of the authorization. If the authorisation was started by another user, this ais consent must match the one stored in the authorization object.

Returns:

the authorization id. Might send the

Throws:

ForbiddenRestException - : consent exists with id

getSCA

@GetMapping(value="/{consentId}/authorisations/{authorisationId}")
org.springframework.http.ResponseEntity<SCAConsentResponseTO> getSCA(@PathVariable(value="consentId")
                                                                                                                                        String consentId,
                                                                                                                                        @PathVariable(value="authorisationId")
                                                                                                                                        String authorisationId)
                                                                                                                                 throws ConflictRestException

Throws:

ConflictRestException

selectMethod

@PutMapping(value="/{consentId}/authorisations/{authorisationId}/scaMethods/{scaMethodId}")
org.springframework.http.ResponseEntity<SCAConsentResponseTO> selectMethod(@PathVariable(value="consentId")
                                                                                                                                                                       String consentId,
                                                                                                                                                                       @PathVariable(value="authorisationId")
                                                                                                                                                                       String authorisationId,
                                                                                                                                                                       @PathVariable(value="scaMethodId")
                                                                                                                                                                       String scaMethodId)
                                                                                                                                                                throws ValidationRestException,
                                                                                                                                                                       ConflictRestException,
                                                                                                                                                                       NotFoundRestException

Throws:

ValidationRestException

ConflictRestException

NotFoundRestException

authorizeConsent

@PutMapping(value="/{consentId}/authorisations/{authorisationId}/authCode")
org.springframework.http.ResponseEntity<SCAConsentResponseTO> authorizeConsent(@PathVariable(value="consentId")
                                                                                                                                                           String consentId,
                                                                                                                                                           @PathVariable(value="authorisationId")
                                                                                                                                                           String authorisationId,
                                                                                                                                                           @RequestParam(name="authCode")
                                                                                                                                                           String authCode)
                                                                                                                                                    throws ValidationRestException,
                                                                                                                                                           NotFoundRestException,
                                                                                                                                                           ConflictRestException

Throws:

ValidationRestException

NotFoundRestException

ConflictRestException

grantPIISConsent

@PostMapping(value="/piis")
org.springframework.http.ResponseEntity<SCAConsentResponseTO> grantPIISConsent(@RequestBody
                                                                                                           AisConsentTO piisConsent)
                                                                                                    throws ForbiddenRestException

Throws:

ForbiddenRestException