Returns the LDAP configuration

Request

Security

ApiKeyAuth

curl -i -X GET \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/management/ldap-config \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

enabledboolean

When set, these settings are enabled. True by default.

Default:true

Example:true

auto_create_usersboolean

When set, the system will automatically create new Accounts for those who have logged in using LDAP. This must be true if LDAP user is not already registered in system. True by default.

Default:true

Example:true

hostnamestring

The hostname of the LDAP server.

Example:"ldap.server.com"

portinteger, [ 0 .. 65535 ]

The port of the LDAP server. Default port is 389 for non-SSL and 636 for SSL.

Example:389

domainsArray of objects, non-empty(Domain)

DCT will try to authenticate using each Domain given in this list.

enable_sslboolean

True if LDAP should be used over SSL.

Default:true

Example:false

truststore_filenamestring, [ 1 .. 1024 ] characters^[a-zA-Z0-9_\.\-]+$

File name of a truststore which can be used to validate the TLS certificate of the LDAP server. The truststore must be available at /etc/config/certs/<truststore_filename>

truststore_passwordstring, [ 1 .. 1024 ] characters

Password for reading trustStore file provided in 'truststore_filename' property

insecure_sslboolean

Allow connections to the LDAP server over LDAPS without validating the TLS certificate. Even though the connection to the server might be performed over LDAPS, setting this property eliminates the protection against a man-in-the-middle attach for connections to this server. Instead, consider creating a truststore with a Certificate Authority to validate the server's certificate, and set the truststore_filename property.

Default:false

unsafe_ssl_hostname_checkboolean

Ignore validation of the name associated to the TLS certificate when connecting to the LDAP server over LDAPS. Setting this value must only be done if the TLS certificate of the server does not match the hostname, and the TLS configuration of the server cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this server. This is ignored if insecure_ssl is set.

Default:false

Response

{
  "enabled": true,
  "auto_create_users": true,
  "hostname": "ldap.server.com",
  "port": 389,
  "domains": [
    { … }
  ],
  "enable_ssl": false,
  "truststore_filename": "string",
  "truststore_password": "string",
  "insecure_ssl": false,
  "unsafe_ssl_hostname_check": false
}