Usage > REST API Configuration
Table Of Contents
Intro
This page describes the usage of the configuration of REST API.
This page describes the configuration values stored in rest-api’s application.properties (or its
template).
General options
| Config Path | Possible Value(s) | Description |
|---|---|---|
javax.net.ssl.keyStore |
string path to JKS file | KeyStore file containing records of private keys to connect to a secure schema registry. E.g.: /path/to/keystore.jks |
javax.net.ssl.keyStorePassword |
string | Password for the file referenced in javax.net.ssl.keyStore. E.g.: password1234 |
javax.net.ssl.trustStore |
string path to JKS file | TrustStore file containing records of trusted certificates to connect to a secure schema registry. E.g.: /path/to/truststore.jks * |
javax.net.ssl.trustStorePassword |
string | Password for the file referenced in javax.net.ssl.trustStore. E.g.: password123 |
enceladus.rest.auth.admin.role |
string | Specifies the admin role to operate property definition create and update operations. |
enceladus.rest.auth.roles.regex |
string - regular expression | Regular expression specifying which user roles to include in JWT. E.g.: ^enceladus_. If the expression filters out the admin role (enceladus.rest.auth.admin.role), account won't be recognized as admin. |
enceladus.rest.auth.ad.server |
string - space-separated AD server domains | ActiveDirectory server domain(s) - multiple values are supported as fallback options. DN (e.g. dc=example,dc=com) should not be included as this is supplied in enceladus.rest.auth.ldap.search.base. Example: enceladus.rest.auth.ad.server=ldaps://first.ldap.here ldaps://second.ldap.here ldaps://third.ldap.here (notice no quotes) |
enceladus.rest.schemaRegistry.baseUrl |
string with URL | Base Url to (secure) schema registry. E.g.: https://localhost:8081 * |
enceladus.rest.schemaRegistry.warnUnsecured |
boolean | If set, in case the javax.net.ssl.* settings are missing or incorrect, the application will issue a warning. Default: True |
Note, that
* enceladus.rest.schemaRegistry.baseUrl may not be present (in that case, the option to load schema from a schema registry by subject name will disappear in the Menas UI)
* specifying javax.net.ssl.{trustStore|keyStore} (and the passwords) is usually both necessary to successfully load a schema file from a secure schema registry, but this setting will be used by the by-URL loading as well (if supported by webserver reached)