ForgeRock Identity Management API — Reconciliation

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Management API — Reconciliation
  description: 'ForgeRock Identity Management API — Reconciliation. 3 operations. Lead operation: ForgeRock List reconciliation
    runs. Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Reconciliation
  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-reconciliation
    baseUri: https://{deployment}/openidm
    description: ForgeRock Identity Management API — Reconciliation business capability. Self-contained, no shared references.
    resources:
    - name: recon
      path: /recon
      operations:
      - name: listreconciliations
        method: GET
        description: ForgeRock List reconciliation runs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: recon-mappingName
      path: /recon/{mappingName}
      operations:
      - name: triggerreconciliation
        method: POST
        description: ForgeRock Trigger reconciliation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: mappingName
          in: path
          type: string
          description: The sync mapping name (e.g., systemLdapAccounts_managedUser)
          required: true
        - name: _action
          in: query
          type: string
          description: Must be recon
          required: true
    - name: recon-reconId
      path: /recon/{reconId}
      operations:
      - name: getreconciliation
        method: GET
        description: ForgeRock Get reconciliation details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reconId
          in: path
          type: string
          description: The reconciliation run identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-management-reconciliation-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Management API — Reconciliation. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/recon
      name: recon
      description: REST surface for recon.
      operations:
      - method: GET
        name: listreconciliations
        description: ForgeRock List reconciliation runs
        call: identity-management-reconciliation.listreconciliations
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recon/{mappingname}
      name: recon-mappingname
      description: REST surface for recon-mappingName.
      operations:
      - method: POST
        name: triggerreconciliation
        description: ForgeRock Trigger reconciliation
        call: identity-management-reconciliation.triggerreconciliation
        with:
          mappingName: rest.mappingName
          _action: rest._action
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recon/{reconid}
      name: recon-reconid
      description: REST surface for recon-reconId.
      operations:
      - method: GET
        name: getreconciliation
        description: ForgeRock Get reconciliation details
        call: identity-management-reconciliation.getreconciliation
        with:
          reconId: rest.reconId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-management-reconciliation-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Management API — Reconciliation. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-list-reconciliation-runs
      description: ForgeRock List reconciliation runs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-reconciliation.listreconciliations
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-trigger-reconciliation
      description: ForgeRock Trigger reconciliation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-management-reconciliation.triggerreconciliation
      with:
        mappingName: tools.mappingName
        _action: tools._action
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-reconciliation-details
      description: ForgeRock Get reconciliation details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-reconciliation.getreconciliation
      with:
        reconId: tools.reconId
      outputParameters:
      - type: object
        mapping: $.