Package de.adorsys.psd2.consent.api

Interface AuthorisationApi

@RequestMapping(path="api/v1/")
public interface AuthorisationApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<CreateAuthorisationResponse>	createConsentAuthorisation(de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType, String parentId, CreateAuthorisationRequest authorisationRequest)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation>	getAuthorisation(String authorisationId)
org.springframework.http.ResponseEntity<List<String>>	getAuthorisationsByParentId(de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType, String parentId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse>	getAuthorisationScaApproach(String authorisationId)
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus>	getAuthorisationScaStatus(de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType, String parentId, String authorisationId)
org.springframework.http.ResponseEntity<Boolean>	isAuthenticationMethodDecoupled(String authorisationId, String authenticationMethodId)
org.springframework.http.ResponseEntity<Void>	saveAuthenticationMethods(String authorisationId, List<CmsScaMethod> methods)
org.springframework.http.ResponseEntity<Void>	updateAuthorisation(String authorisationId, UpdateAuthorisationRequest authorisationRequest)
org.springframework.http.ResponseEntity<Void>	updateAuthorisationStatus(String authorisationId, String scaStatus)
org.springframework.http.ResponseEntity<Boolean>	updateScaApproach(String authorisationId, de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

Method Detail

createConsentAuthorisation

@PostMapping(path="/{authorisation-type}/{parent-id}/authorisations")
org.springframework.http.ResponseEntity<CreateAuthorisationResponse> createConsentAuthorisation(@PathVariable("authorisation-type")
                                                                                                de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType,
                                                                                                @PathVariable("parent-id")
                                                                                                String parentId,
                                                                                                @RequestBody
                                                                                                CreateAuthorisationRequest authorisationRequest)

getAuthorisation

@GetMapping(path="/authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.authorisation.Authorisation> getAuthorisation(@PathVariable("authorisation-id")
                                                                                                                String authorisationId)

updateAuthorisation

@PutMapping(path="/authorisations/{authorisation-id}")
org.springframework.http.ResponseEntity<Void> updateAuthorisation(@PathVariable("authorisation-id")
                                                                  String authorisationId,
                                                                  @RequestBody
                                                                  UpdateAuthorisationRequest authorisationRequest)

updateAuthorisationStatus

@PutMapping(path="/authorisations/{authorisation-id}/status/{status}")
org.springframework.http.ResponseEntity<Void> updateAuthorisationStatus(@PathVariable("authorisation-id")
                                                                        String authorisationId,
                                                                        @PathVariable("status")
                                                                        String scaStatus)

getAuthorisationScaStatus

@GetMapping(path="/{authorisation-type}/{parent-id}/authorisations/{authorisation-id}/status")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.ScaStatus> getAuthorisationScaStatus(@PathVariable("authorisation-type")
                                                                                                           de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType,
                                                                                                           @PathVariable("parent-id")
                                                                                                           String parentId,
                                                                                                           @PathVariable("authorisation-id")
                                                                                                           String authorisationId)

getAuthorisationsByParentId

@GetMapping(path="/{authorisation-type}/{parent-id}/authorisations")
org.springframework.http.ResponseEntity<List<String>> getAuthorisationsByParentId(@PathVariable("authorisation-type")
                                                                                  de.adorsys.psd2.xs2a.core.authorisation.AuthorisationType authorisationType,
                                                                                  @PathVariable("parent-id")
                                                                                  String parentId)

isAuthenticationMethodDecoupled

@GetMapping(path="/authorisations/{authorisation-id}/authentication-methods/{authentication-method-id}")
org.springframework.http.ResponseEntity<Boolean> isAuthenticationMethodDecoupled(@PathVariable("authorisation-id")
                                                                                 String authorisationId,
                                                                                 @PathVariable("authentication-method-id")
                                                                                 String authenticationMethodId)

saveAuthenticationMethods

@PostMapping(path="/authorisations/{authorisation-id}/authentication-methods")
org.springframework.http.ResponseEntity<Void> saveAuthenticationMethods(@PathVariable("authorisation-id")
                                                                        String authorisationId,
                                                                        @RequestBody
                                                                        List<CmsScaMethod> methods)

updateScaApproach

@PutMapping(path="/authorisations/{authorisation-id}/sca-approach/{sca-approach}")
org.springframework.http.ResponseEntity<Boolean> updateScaApproach(@PathVariable("authorisation-id")
                                                                   String authorisationId,
                                                                   @PathVariable("sca-approach")
                                                                   de.adorsys.psd2.xs2a.core.profile.ScaApproach scaApproach)

getAuthorisationScaApproach

@GetMapping(path="/authorisations/{authorisation-id}/sca-approach")
org.springframework.http.ResponseEntity<de.adorsys.psd2.xs2a.core.sca.AuthorisationScaApproachResponse> getAuthorisationScaApproach(@PathVariable("authorisation-id")
                                                                                                                                    String authorisationId)