ForgeRock Identity Gateway API — Objects

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Gateway API — Objects
  description: 'ForgeRock Identity Gateway API — Objects. 2 operations. Lead operation: ForgeRock List configuration objects.
    Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - 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-gateway-objects
    baseUri: https://{deployment}/ig
    description: ForgeRock Identity Gateway API — Objects business capability. Self-contained, no shared references.
    resources:
    - name: openig-api-system-objects
      path: /openig/api/system/objects
      operations:
      - name: listobjects
        method: GET
        description: ForgeRock List configuration objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _queryFilter
          in: query
          type: string
          description: CREST query filter
    - name: openig-api-system-objects-objectType-objectId
      path: /openig/api/system/objects/{objectType}/{objectId}
      operations:
      - name: getobject
        method: GET
        description: ForgeRock Get a configuration object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectType
          in: path
          type: string
          description: Type of the configuration object
          required: true
        - name: objectId
          in: path
          type: string
          description: Identifier of the configuration object
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-gateway-objects-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Gateway API — Objects. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/openig/api/system/objects
      name: openig-api-system-objects
      description: REST surface for openig-api-system-objects.
      operations:
      - method: GET
        name: listobjects
        description: ForgeRock List configuration objects
        call: identity-gateway-objects.listobjects
        with:
          _queryFilter: rest._queryFilter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/openig/api/system/objects/{objecttype}/{objectid}
      name: openig-api-system-objects-objecttype-objectid
      description: REST surface for openig-api-system-objects-objectType-objectId.
      operations:
      - method: GET
        name: getobject
        description: ForgeRock Get a configuration object
        call: identity-gateway-objects.getobject
        with:
          objectType: rest.objectType
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-gateway-objects-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Gateway API — Objects. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: forgerock-list-configuration-objects
      description: ForgeRock List configuration objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-gateway-objects.listobjects
      with:
        _queryFilter: tools._queryFilter
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-configuration-object
      description: ForgeRock Get a configuration object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-gateway-objects.getobject
      with:
        objectType: tools.objectType
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.