This guide shows you how to install and remove Directory Services software components.

Quick Start

DS for Evaluation

Install a server for evaluation or demonstration purposes.


Install a server to hold AM Core Token Service (CTS) data.

DS for AM Identities

Install a server to hold AM identity data.

DS for IDM

Install a server as an external IDM repository.

Setup Hints

Review all setup command options.

DS as a Proxy

Install an LDAP proxy server.


Directory Server and Tools

Pure Java, high-performance server that can be configured as:

  • An LDAPv3 directory server with the additional capability to serve directory data to REST applications over HTTP.

  • An LDAPv3 directory proxy server providing a single point of access to underlying directory servers.

  • A replication server handling replication traffic with directory servers and with other replication servers, receiving, sending, and storing changes to directory data.

Server distributions include command-line tools for installing, configuring, and managing servers. The tools make it possible to script all operations.

DSML Gateway

DSML support is available through the gateway, which is a Java web application that you install in a web container.

REST to LDAP Gateway

In addition to the native server support for REST over HTTP, the REST to LDAP gateway is a Java web application that lets you configure REST access to any LDAPv3 directory server.

Java APIs

Java server-side APIs for server plugins that extend directory services.

All Java APIs have Interface Stability: Evolving. Be prepared for incompatible changes in both major and minor releases.

Read the Release notes. before installing DS software.

ForgeRock Identity Platform™ serves as the basis for our simple and comprehensive Identity and Access Management solution. We help our customers deepen their relationships with their customers, and improve the productivity and connectivity of their employees and partners. For more information about ForgeRock and about the platform, see https://www.forgerock.com.

The ForgeRock Common REST API works across the platform to provide common ways to access web resources and collections of resources.

Read a different version of :