Skip to content

Commit

Permalink
docs: add note about https being required OAuth2
Browse files Browse the repository at this point in the history
Secure protocol is required in OAuth2 according to RFC.

see issue for more information about it

ref issue #146
  • Loading branch information
christian-hawk committed Aug 29, 2022
1 parent 011cf19 commit 641cb4c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Data layers calls oxTrust REST API that handles persistence to multiple backends
| `INBOUND_SAML_OXTRUST_API_HOST` | The oxTrust Api Host (i.e. `mysubdomain.mydomain.org`) | None |
| `INBOUND_SAML_OXTRUST_CLIENT_ID` | OxTrust **API RP** client ID. Open ID Client ID for API Ressource Provider. | None |
| `INBOUND_SAML_OXTRUST_API_COMPLETE_PATH` | OxTrust API Complete Path. (without the first forward slash) | `identity/restv1/api/v1/inbound-saml` |
| `INBOUND_SAML_OXTRUST_API_TOKEN_URL` | OxTrust API Token Url. URL to get token fro oxAuth for accessing the persistence api. | None |
| `INBOUND_SAML_OXTRUST_API_TOKEN_URL` | OxTrust API Token Url. URL to get token fro oxAuth for accessing the persistence api. Should use secure protocol (`https`) according to Oauth2 specs | None |
| `INBOUND_SAML_OXTRUST_API_KID` | Oxtrust **API RP** rs256 `kid` (extracted from jwks) | None |
| `INBOUND_SAML_OXTRUST_API_PVK_PATH` | Oxtrust **rs256 Private Key** extracted from api-rp jwks with above `kid` | None |

Expand Down

0 comments on commit 641cb4c

Please sign in to comment.