Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion _docs_operate/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,10 @@ The HTTP server is the base for the `coreHttpApi` Module. It opens an express HT

configure the CORS middleware. Valid options can be found [here](https://github.com/expressjs/cors#configuration-options).

- **apiKey** `required`
- **apiKey** `optional`

For a productive Connector at least one of the three configuration parameters **apiKey**, **oidc** and **jwtBearer** must be set.
{: .notice--info}

Define the API-Key the Connector should use to authenticate requests.

Expand All @@ -247,6 +250,28 @@ The HTTP server is the base for the `coreHttpApi` Module. It opens an express HT

The API-Key protects your Connector from unauthorized access and should therefore be kept secret.

- **oidc** `optional`

For a productive Connector at least one of the three configuration parameters **apiKey**, **oidc** and **jwtBearer** must be set.
{: .notice--info}

Defines the setting for the connection to your OIDC server.

The full configuration can be found [here](https://auth0.github.io/express-openid-connect/interfaces/ConfigParams.html).

Because the OIDC process requires a redirect this type of authentication is only available when the user cales the Connector via browser.

- **jwtBearer** `optional`

For a productive Connector at least one of the three configuration parameters **apiKey**, **oidc** and **jwtBearer** must be set.
{: .notice--info}

Defines the setting for the OAuth 2.0 JWT bearer authorization.

The full configuration can be found [here](https://auth0.github.io/node-oauth2-jwt-bearer/interfaces/AuthOptions.html).

The JWT from the OAuth 2.0 provider needs to be send via the `Authorizaion` header with the Bearer prefix.

- **helmetOptions** `default: depending on the Connector mode`

Configure the [helmet](https://helmetjs.github.io/) middleware.
Expand Down