ForgeRock

ForgeRock Synchronization API

Trigger on-demand synchronization

Documentation GitHub OpenAPI

Operations 1

POST /sync ForgeRock Trigger on-demand synchronization #

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-synchronization-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 Synchronization 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: Synchronization
  description: Trigger on-demand synchronization
paths:
  /sync:
    post:
      operationId: triggerSync
      summary: ForgeRock Trigger on-demand synchronization
      description: Trigger a synchronization action for a specific object change. Useful for performing immediate sync of individual objects.
      tags:
      - Synchronization
      parameters:
      - name: _action
        in: query
        required: true
        description: Must be performAction
        schema:
          type: string
          enum:
          - performAction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  description: The sync action to perform
                  enum:
                  - CREATE
                  - UPDATE
                  - DELETE
                  - LINK
                  - UNLINK
                mapping:
                  type: string
                  description: The mapping name
                sourceId:
                  type: string
                  description: The source object identifier
      responses:
        '200':
          description: Sync action performed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  action:
                    type: string
components:
  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)