This guide shows you how to configure and use DS REST APIs to access directory services over HTTP. The RESTful HTTP APIs return directory data as JSON resources. DS APIs are based on the ForgeRock® Common REST API framework.

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

Quick Start


Create entries over HTTP.


Read entries over HTTP.


Update entries over HTTP.


Delete entries over HTTP.


Query the directory over HTTP.

Passwords and Accounts

Change passwords and get account usability information.

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.

Read a different version of :