Page tree
Skip to end of metadata
Go to start of metadata

The SSL Configuration API allows you to work with some of the LucidWorks Search Secure Socket Layer-related settings. This API does not support configuring the Container-related settings. For more information about configuring the container-related SSL settings, see Enabling SSL.

It is possible to configure LucidWorks Search to allow only mutually authenticated SSL traffic. This feature is controlled with the parameters auth_require_authorization and auth_authorized_clients. When you set auth_require_authorization to true you can control which clients are allowed to access LucidWorks Search by listing the DNs from the certificates in auth_authorized_clients.

If you'd like to configure LucidWorks Search to use SSL between the LWE-Core and LWE-Connectors components, see the section Client Certificates for LWE-Core and Connectors.

API Entry Points

api/config/ssl: List or update the existing SSL configuration.

List the Existing SSL Configuration

GET api/config/ssl

Input

Path Parameters

None.

Query Parameters

None.

Output

Output Content

JSON block with these parameters:

Key

Type

Required

Default

Description

auth_require_authorization

boolean

no

 

Enforces client authorization (with certificates). When enabled, only clients that are listed in auth_authorized_clients are allowed to access /api and /solr paths.

auth_authorized_clients

array of strings

no

[]

Lists authorized clients (certificate DN), only relevant when auth_require_authorization is set to true.

Examples

List authorized client configuration:

Input

Output

Back to Top

Update SSL Configuration

PUT /api/config/ssl

Input

Path Parameters

None.

Query Parameters

None.

Input Content

JSON block with these parameters:

Key

Type

Required

Default

Description

auth_require_authorization

boolean

no

 

Enforces client authorization (with certificates). When enabled, only clients that are listed in auth_authorized_clients are allowed to access /api and /solr paths.

auth_authorized_clients

array of strings

no

[]

Lists authorized clients (certificate DN), only relevant when auth_require_authorization is set to true.

Output

Output Content

None.

Examples

Configure LucidWorks Search so only authorized clients may communicate:

Input

Output

None.

Back to Top