ForgeRock Identity Management API — Managed Objects

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Management API — Managed Objects
  description: 'ForgeRock Identity Management API — Managed Objects. 6 operations. Lead operation: ForgeRock List managed
    objects. Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Managed Objects
  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-managed-objects
    baseUri: https://{deployment}/openidm
    description: ForgeRock Identity Management API — Managed Objects business capability. Self-contained, no shared references.
    resources:
    - name: managed-objectType
      path: /managed/{objectType}
      operations:
      - name: listmanagedobjects
        method: GET
        description: ForgeRock List managed objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createmanagedobject
        method: POST
        description: ForgeRock Create a managed object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _action
          in: query
          type: string
          description: Must be set to create for server-assigned IDs
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: managed-objectType-objectId
      path: /managed/{objectType}/{objectId}
      operations:
      - name: getmanagedobject
        method: GET
        description: ForgeRock Get a managed object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatemanagedobject
        method: PUT
        description: ForgeRock Replace a managed object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-Match
          in: header
          type: string
          description: Revision for optimistic concurrency control
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchmanagedobject
        method: PATCH
        description: ForgeRock Patch a managed object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-Match
          in: header
          type: string
          description: Revision for optimistic concurrency control
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletemanagedobject
        method: DELETE
        description: ForgeRock Delete a managed object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-Match
          in: header
          type: string
          description: Revision for optimistic concurrency control
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-management-managed-objects-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Management API — Managed Objects. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/managed/{objecttype}
      name: managed-objecttype
      description: REST surface for managed-objectType.
      operations:
      - method: GET
        name: listmanagedobjects
        description: ForgeRock List managed objects
        call: identity-management-managed-objects.listmanagedobjects
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createmanagedobject
        description: ForgeRock Create a managed object
        call: identity-management-managed-objects.createmanagedobject
        with:
          _action: rest._action
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/managed/{objecttype}/{objectid}
      name: managed-objecttype-objectid
      description: REST surface for managed-objectType-objectId.
      operations:
      - method: GET
        name: getmanagedobject
        description: ForgeRock Get a managed object
        call: identity-management-managed-objects.getmanagedobject
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatemanagedobject
        description: ForgeRock Replace a managed object
        call: identity-management-managed-objects.updatemanagedobject
        with:
          If-Match: rest.If-Match
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchmanagedobject
        description: ForgeRock Patch a managed object
        call: identity-management-managed-objects.patchmanagedobject
        with:
          If-Match: rest.If-Match
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletemanagedobject
        description: ForgeRock Delete a managed object
        call: identity-management-managed-objects.deletemanagedobject
        with:
          If-Match: rest.If-Match
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-management-managed-objects-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Management API — Managed Objects. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-list-managed-objects
      description: ForgeRock List managed objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-managed-objects.listmanagedobjects
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-create-managed-object
      description: ForgeRock Create a managed object
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-management-managed-objects.createmanagedobject
      with:
        _action: tools._action
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-managed-object
      description: ForgeRock Get a managed object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-managed-objects.getmanagedobject
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-replace-managed-object
      description: ForgeRock Replace a managed object
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: identity-management-managed-objects.updatemanagedobject
      with:
        If-Match: tools.If-Match
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-patch-managed-object
      description: ForgeRock Patch a managed object
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: identity-management-managed-objects.patchmanagedobject
      with:
        If-Match: tools.If-Match
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-delete-managed-object
      description: ForgeRock Delete a managed object
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: identity-management-managed-objects.deletemanagedobject
      with:
        If-Match: tools.If-Match
      outputParameters:
      - type: object
        mapping: $.