ForgeRock Identity Management API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Management API — Configuration
  description: 'ForgeRock Identity Management API — Configuration. 4 operations. Lead operation: ForgeRock List configuration
    objects. Self-contained Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Configuration
  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-configuration
    baseUri: https://{deployment}/openidm
    description: ForgeRock Identity Management API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: config
      path: /config
      operations:
      - name: listconfigurations
        method: GET
        description: ForgeRock List configuration objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: config-configId
      path: /config/{configId}
      operations:
      - name: getconfiguration
        method: GET
        description: ForgeRock Get a configuration object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configId
          in: path
          type: string
          description: Configuration object identifier (e.g., managed, sync, audit)
          required: true
      - name: updateconfiguration
        method: PUT
        description: ForgeRock Update a configuration object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configId
          in: path
          type: string
          description: Configuration object identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconfiguration
        method: DELETE
        description: ForgeRock Delete a configuration object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: configId
          in: path
          type: string
          description: Configuration object identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-management-configuration-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Management API — Configuration. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/config
      name: config
      description: REST surface for config.
      operations:
      - method: GET
        name: listconfigurations
        description: ForgeRock List configuration objects
        call: identity-management-configuration.listconfigurations
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/{configid}
      name: config-configid
      description: REST surface for config-configId.
      operations:
      - method: GET
        name: getconfiguration
        description: ForgeRock Get a configuration object
        call: identity-management-configuration.getconfiguration
        with:
          configId: rest.configId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconfiguration
        description: ForgeRock Update a configuration object
        call: identity-management-configuration.updateconfiguration
        with:
          configId: rest.configId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconfiguration
        description: ForgeRock Delete a configuration object
        call: identity-management-configuration.deleteconfiguration
        with:
          configId: rest.configId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-management-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Management API — Configuration. 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-management-configuration.listconfigurations
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-configuration-object
      description: ForgeRock Get a configuration object
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-management-configuration.getconfiguration
      with:
        configId: tools.configId
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-update-configuration-object
      description: ForgeRock Update a configuration object
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: identity-management-configuration.updateconfiguration
      with:
        configId: tools.configId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-delete-configuration-object
      description: ForgeRock Delete a configuration object
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: identity-management-configuration.deleteconfiguration
      with:
        configId: tools.configId
      outputParameters:
      - type: object
        mapping: $.