This repository demonstrates Cloudentity's capabilities for handling Openbanking scenarios.
You can find here a sample implementation of TPP, consent-page, bank, admin and self-service apps.
The following specifications are currently supported:
- Openbanking UK
- Openbanking Brasil
- CDR
- FDX (partial support)
For more details, please visit our Openbanking Guides.
makedocker> 20.10.2docker-compose> 1.29.0
For Windows you need to use WSL.
There are two ways you can run quickstart.
If you want to set up everything locally then you need to contact [email protected] to get credentials to be able to download ACP docker image.
The other option is to register and use ACP in SaaS: https://authz.cloudentity.io
| ACP type | Associated Environment File | Additional Configuration needed? |
|---|---|---|
| Local | .env-local | No, everything is good to go out of the box. You shouldn't need to touch this file |
| SAAS | .env-saas | Yes, running with saas takes a few extra steps |
By default, MFA is turned off.
- Run
make enable-mfato turn MFA on.- Run
make disable-mfato turn MFA off.
The current types of runtimes are currently supported:
- Open Banking UK with local ACP instance:
make run-obuk-local - Open Banking UK with SAAS ACP:
make run-obuk-saas - Open Banking Brasil with local ACP instance:
make run-obbr-local - Open Banking Brasil with SAAS ACP:
make run-obbr-saas - CDR with local ACP instance:
make run-cdr-local
| Mode | Instructions |
|---|---|
| With Cypress UI | Run make run-tests to open Cypress GUI with tests scenarios. Then click on the intended test suite name {TEST_NAME}.ts |
| Headless (commandline) | Run one of the following: run-obuk-tests-headless, run-obbr-tests-headless, run-cdr-tests-headless |
- Enable System workspace on your ACP SAAS Tenant (you will most likely need to contact someone at Cloudentity to do this for you)
- Go to "System" workspace and create a new application with
manage_configurationscope andclient_credentialsgrant type - Configure the
.env-saasfile with the following:- Saas tenant id
- id of the client you created in step 2
- secret of the client you created in step 2
- Now you are ready to run one of the saas related makefile targets
The current types of runtimes are currently supported:
- Open Banking UK with local ACP instance:
make run-obuk-local - Open Banking UK with SAAS ACP:
make run-obuk-saas - Open Banking Brasil with local ACP instance:
make run-obbr-local - Open Banking Brasil with SAAS ACP:
make run-obbr-saas - CDR with local ACP instance:
make run-cdr-local - FDX with local ACP instance:
make run-fdx-local - FDX with SAAS ACP:
make run-fdx-saas
By default, MFA is turned off.
- Run
make enable-mfato turn MFA on.- Run
make disable-mfato turn MFA off.
To clean up the environment execute: make clean.
This step is also necessary if you want to switch between different specs.
To run using Hypr Passwordless see Hypr Passwordless Setup
Once you can run the quickstart, you can visit our sample apps:
| Name | Url | Credentials | Availability |
|---|---|---|---|
| Financroo TPP | https://localhost:8091 |
test / p@ssw0rd! |
|
| Developer TPP | https://localhost:8090 |
user user2 user3 / p@ssw0rd! |
|
| Consent self service portal | https://localhost:8085 |
user user2 user3 / p@ssw0rd! |
|
| Consent admin portal | https://localhost:8086 |
admin / p@ssw0rd! |
|
| ACP admin portal | https://authorization.cloudentity.com:8443 |
admin / admin |
only local deployment |
| Mode | Instructions |
|---|---|
| With Cypress UI | Run make run-tests to open Cypress GUI with tests scenarios. Then click on the intended test suite name {TEST_NAME}.ts |
| Headless (commandline) | Run one of the following: run-obuk-tests-headless, run-obbr-tests-headless, run-cdr-tests-headless |
- Bank - Apache 2.0
- Developer TPP - Apache 2.0
- Financroo TPP - Apache 2.0
- Configuration app - Apache 2.0
- Consent self-service portal - Apache 2.0
- Consent admin portal - Apache 2.0
- Consent page - Apache 2.0