ForgeRock

ForgeRock Reconciliation API

Trigger and manage reconciliation operations

Documentation GitHub OpenAPI

Operations 3

POST /recon/{mappingName} ForgeRock Trigger reconciliation #

GET /recon ForgeRock List reconciliation runs #

GET /recon/{reconId} ForgeRock Get reconciliation details #

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-reconciliation-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 Identity Management Reconciliation API
  description: REST API for ForgeRock Identity Management (IDM) providing CRUD operations on managed objects and identity lifecycle management. Supports provisioning, synchronization, reconciliation, workflow-driven identity operations, and configuration management through the /openidm context path.
  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: identity-management
servers:
- url: https://{deployment}/openidm
  description: ForgeRock Identity Management server
  variables:
    deployment:
      default: idm.example.com
      description: The IDM deployment hostname
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Reconciliation
  description: Trigger and manage reconciliation operations
paths:
  /recon/{mappingName}:
    post:
      operationId: triggerReconciliation
      summary: ForgeRock Trigger reconciliation
      description: Trigger a reconciliation operation for the specified mapping. The mapping defines the source and target systems and the synchronization rules.
      tags:
      - Reconciliation
      parameters:
      - name: mappingName
        in: path
        required: true
        description: The sync mapping name (e.g., systemLdapAccounts_managedUser)
        schema:
          type: string
      - name: _action
        in: query
        required: true
        description: Must be recon
        schema:
          type: string
          enum:
          - recon
      responses:
        '200':
          description: Reconciliation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconciliationResult'
        '404':
          description: Mapping not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /recon:
    get:
      operationId: listReconciliations
      summary: ForgeRock List reconciliation runs
      description: Query reconciliation run records. Returns details about past and in-progress reconciliation operations.
      tags:
      - Reconciliation
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/SortKeys'
      responses:
        '200':
          description: List of reconciliation records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconciliationList'
  /recon/{reconId}:
    get:
      operationId: getReconciliation
      summary: ForgeRock Get reconciliation details
      description: Retrieve details about a specific reconciliation run.
      tags:
      - Reconciliation
      parameters:
      - name: reconId
        in: path
        required: true
        description: The reconciliation run identifier
        schema:
          type: string
      responses:
        '200':
          description: Reconciliation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconciliationResult'
        '404':
          description: Reconciliation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ReconciliationList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/ReconciliationResult'
        resultCount:
          type: integer
    ReconciliationResult:
      type: object
      description: Reconciliation run result
      properties:
        _id:
          type: string
          description: Reconciliation run identifier
        state:
          type: string
          description: Current state
          enum:
          - SUCCESS
          - FAILED
          - ACTIVE
          - CANCELED
        stage:
          type: string
        mapping:
          type: string
          description: The mapping name
        started:
          type: string
          format: date-time
        ended:
          type: string
          format: date-time
        progress:
          type: object
          properties:
            source:
              type: object
              properties:
                existing:
                  type: object
                  properties:
                    processed:
                      type: integer
                    total:
                      type: string
            target:
              type: object
              properties:
                existing:
                  type: object
                  properties:
                    processed:
                      type: integer
                    total:
                      type: string
        situationSummary:
          type: object
          description: Summary of situations found during reconciliation
          additionalProperties:
            type: integer
        statusSummary:
          type: object
          description: Summary of action outcomes
          additionalProperties:
            type: integer
    ErrorResponse:
      type: object
      description: Standard CREST error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  parameters:
    SortKeys:
      name: _sortKeys
      in: query
      description: Comma-separated sort fields (prefix with - for descending)
      schema:
        type: string
    PageSize:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token or IDM session token
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication (for internal admin access)