ForgeRock Identity Management API — System Objects

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Management API — System Objects
  description: 'ForgeRock Identity Management API — System Objects. 2 operations. Lead operation: ForgeRock List system objects.
    Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - System 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-system-objects
    baseUri: https://{deployment}/openidm
    description: ForgeRock Identity Management API — System Objects business capability. Self-contained, no shared references.
    resources:
    - name: system-systemName-objectType
      path: /system/{systemName}/{objectType}
      operations:
      - name: listsystemobjects
        method: GET
        description: ForgeRock List system objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: systemName
          in: path
          type: string
          description: Name of the connected system
          required: true
        - name: objectType
          in: path
          type: string
          description: Object type in the connected system (e.g., account, group)
          required: true
    - name: system-systemName-objectType-objectId
      path: /system/{systemName}/{objectType}/{objectId}
      operations:
      - name: getsystemobject
        method: GET
        description: ForgeRock Get a system object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: systemName
          in: path
          type: string
          description: Name of the connected system
          required: true
        - name: objectType
          in: path
          type: string
          description: Object type in the connected system
          required: true
        - name: objectId
          in: path
          type: string
          description: Object identifier in the remote system
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-management-system-objects-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Management API — System Objects. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/system/{systemname}/{objecttype}
      name: system-systemname-objecttype
      description: REST surface for system-systemName-objectType.
      operations:
      - method: GET
        name: listsystemobjects
        description: ForgeRock List system objects
        call: identity-management-system-objects.listsystemobjects
        with:
          systemName: rest.systemName
          objectType: rest.objectType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/{systemname}/{objecttype}/{objectid}
      name: system-systemname-objecttype-objectid
      description: REST surface for system-systemName-objectType-objectId.
      operations:
      - method: GET
        name: getsystemobject
        description: ForgeRock Get a system object
        call: identity-management-system-objects.getsystemobject
        with:
          systemName: rest.systemName
          objectType: rest.objectType
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-management-system-objects-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Management API — System Objects. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: forgerock-list-system-objects
      description: ForgeRock List system objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-system-objects.listsystemobjects
      with:
        systemName: tools.systemName
        objectType: tools.objectType
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-system-object
      description: ForgeRock Get a system object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-system-objects.getsystemobject
      with:
        systemName: tools.systemName
        objectType: tools.objectType
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.