ForgeRock

ForgeRock Entries API

Generic LDAP entry operations via HDAP

Documentation GitHub OpenAPI

Operations 1

GET /api/{collection} List directory entries #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/forgerock-entries-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ForgeRock Directory Services Entries API
  description: HTTP Directory Access Protocol (HDAP) REST API for ForgeRock Directory Services (DS). Provides JSON-based access to directory data, translating HTTP operations into LDAP operations and mapping JSON resources to LDAP entries. Supports CRUD operations, search, and password management for directory entries.
  version: 7.4.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: directory-services
servers:
- url: https://{deployment}/ds
  description: ForgeRock Directory Services HDAP endpoint
  variables:
    deployment:
      default: ds.example.com
      description: The DS deployment hostname
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Entries
  description: Generic LDAP entry operations via HDAP
paths:
  /api/{collection}:
    get:
      operationId: listEntries
      summary: List directory entries
      description: Query entries from any HDAP-configured collection endpoint. The collection maps to an LDAP subtree with a defined JSON-to-LDAP mapping.
      tags:
      - Entries
      parameters:
      - name: collection
        in: path
        required: true
        description: The HDAP collection name
        schema:
          type: string
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PagedResultsCookie'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryQueryResult'
components:
  parameters:
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    PagedResultsCookie:
      name: _pagedResultsCookie
      in: query
      description: Cookie from a previous page for server-side paging
      schema:
        type: string
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression, translated to an LDAP filter (e.g., uid eq "jdoe" becomes (uid=jdoe))
      schema:
        type: string
    Fields:
      name: _fields
      in: query
      description: Comma-separated list of fields to return
      schema:
        type: string
  schemas:
    EntryQueryResult:
      type: object
      description: Generic HDAP query result
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              _rev:
                type: string
            additionalProperties: true
        resultCount:
          type: integer
        pagedResultsCookie:
          type: string
        totalPagedResults:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication (for directory bind)