LDAP Configuration

This section explains how to configure an LDAP server.

Configure Secure LDAP

To configure an LDAP server in the PCE, you need to configure LDAP for SSL authentication.

You can secure LDAP with SSL/TLS Certificates using these three methods:

Use PCE Web UI to Configure Secure LDAP
Install LDAP TLS Certificates from the PCE Command-Line to the PCE System CA Store.
Configure LDAP for SSL authentication using REST APIs

Configure LDAP for SSL authentication

The following APIs are used to configure LDAP for SSL:

GET /authentication_settings/ldap_configs
GET /authentication_settings/ldap_configs/:uuid
POST /authentication_settings/ldap_configs
PUT /authentication_settings/ldap_configs/:uuid

The required property is tls_ca_bundle.

To manage TLS CA bundle for LDAP authentication, use these APIs:

GET /login_proxy_ldap_configs
POST /login_proxy_ldap_configs
PUT /login_proxy_ldap_configs/update

Update LDAP configuration

This section outlines how to update the LDAP server configuration in the PCE.

For information about the request parameters, see LDAP Authentication Reference.

PUT /api/v2/authentication_settings/ldap_configs/:uuid

where uuid indicates the LDAP server configuration UUID.

Request body:

{
        "address" :  "ldap-1.mycompany.com" ,
        "bind_password" :  "qw3r!y123!!" ,
       "full_name_attribute" :  "displayName" ,
        "port" : 636,
        "insecure_disable_tls_certificate_verification": true
}

Response:

The following response codes can be returned:

204: indicates success
403: indicates the user is not an org owner
404: indicates LDAP configuration not found or an attempt to update LDAP configuration in another domain
406: indicates invalid parameters

Delete LDAP Server Configuration

This API deletes the configuration for an LDAP server in the PCE. For information about the request parameters, see LDAP Configuration Parameters Overview.

DELETE /api/v2/authentication_settings/ldap_configs/:uuid

where uuid indicates the LDAP server configuration uuid

Request body: none