ForgeRock Identity Management API — Synchronization

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Management API — Synchronization
  description: 'ForgeRock Identity Management API — Synchronization. 1 operations. Lead operation: ForgeRock Trigger on-demand
    synchronization. Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Synchronization
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FORGEROCK_API_KEY: FORGEROCK_API_KEY
capability:
  consumes:
  - type: http
    namespace: identity-management-synchronization
    baseUri: https://{deployment}/openidm
    description: ForgeRock Identity Management API — Synchronization business capability. Self-contained, no shared references.
    resources:
    - name: sync
      path: /sync
      operations:
      - name: triggersync
        method: POST
        description: ForgeRock Trigger on-demand synchronization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _action
          in: query
          type: string
          description: Must be performAction
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-management-synchronization-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Management API — Synchronization. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/sync
      name: sync
      description: REST surface for sync.
      operations:
      - method: POST
        name: triggersync
        description: ForgeRock Trigger on-demand synchronization
        call: identity-management-synchronization.triggersync
        with:
          _action: rest._action
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-management-synchronization-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Management API — Synchronization. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-trigger-demand-synchronization
      description: ForgeRock Trigger on-demand synchronization
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-management-synchronization.triggersync
      with:
        _action: tools._action
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.