ForgeRock Entries API

openapi: 3.1.0
info:
  title: ForgeRock Access Management Access Requests Entries API
  description: REST API for ForgeRock Access Management (AM) providing authentication, authorization, session management, and policy evaluation. Supports OAuth 2.0 and OpenID Connect flows, authentication trees/journeys, policy-based authorization decisions, and realm management.
  version: 7.3.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: access-management
servers:
- url: https://{deployment}/am
  description: ForgeRock Access Management server
  variables:
    deployment:
      default: am.example.com
      description: The AM deployment hostname
security:
- ssoToken: []
- bearerAuth: []
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:
    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
    PagedResultsCookie:
      name: _pagedResultsCookie
      in: query
      description: Cookie from a previous page for server-side paging
      schema:
        type: string
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    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:
    ssoToken:
      type: apiKey
      in: header
      name: iPlanetDirectoryPro
      description: AM SSO token obtained from authentication
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token