Example Configuration
api:
port: 2000
flow:
- basicAuthentication:
users:
- username: user
password: user123
- username: admin
password: admin456
target:
url: https://api.predic8.de
api:
port: 2000
flow:
- basicAuthentication:
users:
- username: user
password: user123
- username: admin
password: admin456
target:
url: https://api.predic8.de
Syntax
basicAuthentication:
'$ref': <string>
cachingUserDataProvider: {}
customStatementJdbcUserDataProvider: {}
htpasswdFileProvider: {}
jdbcUserDataProvider: {}
ldapUserDataProvider: {}
removeAuthorizationHeader: <boolean>
staticUserDataProvider: {}
unifyingUserDataProvider:
- <userDataProviders>
users:
- <staticUserDataProvider-user>
basicAuthentication:
'$ref': <string>
cachingUserDataProvider: {}
customStatementJdbcUserDataProvider: {}
htpasswdFileProvider: {}
jdbcUserDataProvider: {}
ldapUserDataProvider: {}
removeAuthorizationHeader: <boolean>
staticUserDataProvider: {}
unifyingUserDataProvider:
- <userDataProviders>
users:
- <staticUserDataProvider-user>
Attributes
| Name | Required | Default | Description | Examples |
|---|---|---|---|---|
| $ref | false | - | Reference a component defined under components. | - |
| removeAuthorizationHeader | false | true | Removes the Authorization header after successful authentication. Default is true to prevent credentials from being forwarded to backends. Set to false if both gateway and backend need to validate credentials. | - |
Child Structure
| Element | Cardinality | Description |
|---|---|---|
| cachingUserDataProvider | 0..1 | Caching User Data provider caches previous successful logins in order to make authentication faster |
| customStatementJdbcUserDataProvider | 0..1 | |
| htpasswdFileProvider | 0..1 | A user data provider utilizing htpasswd-style files. |
| jdbcUserDataProvider | 0..1 | |
| ldapUserDataProvider | 0..1 | A user data provider querying an LDAP server to authorize users and retrieve attributes. |
| staticUserDataProvider | 0..1 | A user data provider listing all user data in-place in the config file. |
| userDataProviders | 0..* | |
| staticUserDataProvider-user | 0..* | A list of username/password combinations to accept. |