mirror of
https://github.com/OpenBankProject/OBP-API.git
synced 2026-02-06 11:27:05 +00:00
Documented OAuth 2.0
This commit is contained in:
parent
fe5ad82d86
commit
93bd8604c4
22
README.md
22
README.md
@ -547,6 +547,28 @@ There are 3 API's endpoint related to webhooks:
|
||||
1. `POST ../banks/BANK_ID/account-web-hooks` - Create an Account Webhook
|
||||
2. `PUT ../banks/BANK_ID/account-web-hooks` - Enable/Disable an Account Webhook
|
||||
3. `GET ../management/banks/BANK_ID/account-web-hooks` - Get Account Webhooks
|
||||
---
|
||||
## OAuth 2.0
|
||||
In order to enable an OAuth2 workflow at an instance of OBP-API backend app you need to setup next props:
|
||||
```
|
||||
# -- OAuth 2 ---------------------------------------------------------------
|
||||
# Enable/Disable OAuth 2 workflow at a server instance
|
||||
# In case isn't defined default value is false
|
||||
# allow_oauth2_login=false
|
||||
# URL of Public server JWK set used for validating bearer JWT access tokens
|
||||
# oauth2.jwk_set.url=http://localhost:8080/jwk.json
|
||||
# ----------------------------------------------------------- OAuth 2 ------
|
||||
|
||||
OpenID Connect is supported.
|
||||
Tested Identity providers: Google, MITREId.
|
||||
|
||||
```
|
||||
### Example for Google's OAuth 2.0 implementation for authentication, which conforms to the OpenID Connect specification
|
||||
```
|
||||
allow_oauth2_login=true
|
||||
oauth2.jwk_set.url=https://www.googleapis.com/oauth2/v3/certs
|
||||
```
|
||||
---
|
||||
|
||||
## Scala / Lift
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user