Using the Configuration API - PingDirectory

Page created: 15 Jul 2022 |

Page updated: 20 Jan 2023

| 1 min read

9.2 Product PingDirectory Directory Capability Product documentation Content Type Administration User task Configuration IT Administrator Administrator Audience System Administrator Software Deployment Method

The PingDirectory server provides a Configuration API when updating the server configuration with LDAP is not possible. The API is consistent with the System for Cross-domain Identity Management (SCIM) 2.0 protocol and uses JSON as a text exchange format, so all request headers allow the application/json content type.

The server includes a servlet extension that provides read and write access to the server’s configuration over HTTP.

To add the extension to one of the server’s HTTP Connection Handlers, run the following code.
```
$ bin/dsconfig set-connection-handler-prop \  
  --handler-name "HTTPS Connection Handler" \  
  --add http-servlet-extension:Configuration
```
Note:
By default, the extension is enabled for new installations. You can enable the extension for existing deployments.

The API is made available on the HTTPS Connection Handler’s host:port in the /config context. Due to the potentially sensitive nature of the server’s configuration, use the HTTPS Connection Handler for hosting the configuration extension.