You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-13Lines changed: 37 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,9 @@ The OBP API abstracts away the peculiarities of each core banking system so that
12
12
13
13
Our tagline is: "Bank as a Platform. Transparency as an Asset".
14
14
15
-
The API supports [OAuth 1.0a](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#OAuth%201.0a), [OAuth 2](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#OAuth%202), [OpenID Connect OIDC](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#OAuth%202%20with%20Google) and other authentication methods including [Direct Login](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#Direct%20Login).
15
+
The API supports [OAuth 2](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#OAuth%202), [OpenID Connect OIDC](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#OAuth%202%20with%20Google), [Direct Login](https://apiexplorer-ii-sandbox.openbankproject.com/glossary#Direct%20Login), and other authentication methods.
16
+
17
+
**Note:** OAuth 1.0a support has been removed. Please use OAuth 2.0, OpenID Connect, or Direct Login for authentication.
16
18
17
19
## Documentation
18
20
@@ -459,18 +461,36 @@ We use 9 to run the API in production mode.
459
461
460
462
- You should now be able to browse to `localhost:8080` (or `yourIPaddress:8080`).
461
463
462
-
## Using OBP-API in different app modes
464
+
## Server Mode Configuration (Removed)
465
+
466
+
**IMPORTANT:** The `server_mode` configuration property has been completely removed from OBP-API.
467
+
468
+
OBP-API now operates exclusively as a backend API server. There is no configuration needed - the application automatically runs in API-only mode.
469
+
470
+
### What Changed
471
+
472
+
- ❌ `server_mode=portal` - Removed (no longer supported)
473
+
- ❌ `server_mode=apis` - Removed (no longer needed, this is now the default and only mode)
474
+
- ❌ `server_mode=apis,portal` - Removed (no longer supported)
475
+
476
+
### Migration
477
+
478
+
If your props file contains `server_mode`, you can safely remove it. The property is ignored.
463
479
464
-
1.`portal` => OBP-API as a portal i.e. without REST API.
465
-
2.`apis` => OBP-API as an _APIs_ app i.e. only REST APIs.
466
-
3.`apis,portal`=> OBP-API as portal and apis i.e. REST APIs and web portal.
480
+
**Before:**
481
+
```properties
482
+
server_mode=apis
483
+
```
467
484
468
-
- Edit your props file(s) to contain one of the next cases:
469
-
1.`server_mode=portal`
470
-
2.`server_mode=apis`
471
-
3.`server_mode=apis,portal`
485
+
**After:**
486
+
```properties
487
+
# server_mode property removed - no configuration needed
488
+
# OBP-API automatically runs in API-only mode
489
+
```
472
490
473
-
In case it is not defined, the default case is the 3rd one. For example, `server_mode=apis,portal`.
491
+
**For portal/UI functionality:** Deploy the separate [OBP-Portal](https://github.com/OpenBankProject/OBP-Portal) application.
492
+
493
+
For migration instructions, see `.kiro/specs/remove-lift-portal-pages/MIGRATION_GUIDE.md`
474
494
475
495
## Using Akka remote storage
476
496
@@ -554,7 +574,9 @@ Please refer to the [Code Generation](https://github.com/OpenBankProject/OBP-API
554
574
555
575
## Customize Portal WebPage
556
576
557
-
Please refer to the [Custom Webapp](obp-api/src/main/resources/custom_webapp/README.md) for links.
577
+
**DEPRECATED:** Portal functionality has been removed from OBP-API.
578
+
579
+
For UI customization, please use the separate [OBP-Portal](https://github.com/OpenBankProject/OBP-Portal) project.
558
580
559
581
## Using jetty password obfuscation with props file
560
582
@@ -679,7 +701,9 @@ There are 3 API endpoints related to webhooks:
679
701
680
702
## OpenID Connect
681
703
682
-
In order to enable an OIDC workflow at an instance of OBP-API portal app(login functionality) you need to set up the following props:
704
+
**Note:** OpenID Connect authentication is supported for API authentication. Portal login functionality has been moved to the separate [OBP-Portal](https://github.com/OpenBankProject/OBP-Portal) project.
705
+
706
+
In order to enable OIDC authentication for API access, you need to set up the following props:
683
707
684
708
```props
685
709
## Google as an identity provider
@@ -705,7 +729,7 @@ In order to enable an OIDC workflow at an instance of OBP-API portal app(login f
705
729
# openid_connect_2.button_text = Yahoo
706
730
```
707
731
708
-
Please note in the example above you MUST run OBP-API portal at the URL: http://127.0.0.1:8080
732
+
**Note:** The callback URL should match your OBP-API deployment URL (e.g., `http://127.0.0.1:8080/auth/openid-connect/callback`).
0 commit comments