ForgeRock · Capability

ForgeRock Identity Gateway API — Routes

ForgeRock Identity Gateway API — Routes. 5 operations. Lead operation: ForgeRock List routes. Self-contained Naftiko capability covering one Forgerock business surface.

Run with Naftiko ForgerockRoutes

What You Can Do

GET

Listroutes — ForgeRock List routes

/v1/openig/api/system/objects/router-handler/routes

POST

Createroute — ForgeRock Create a route

/v1/openig/api/system/objects/router-handler/routes

GET

Getroute — ForgeRock Get a route

/v1/openig/api/system/objects/router-handler/routes/{routeid}

PUT

Updateroute — ForgeRock Update a route

/v1/openig/api/system/objects/router-handler/routes/{routeid}

DELETE

Deleteroute — ForgeRock Delete a route

/v1/openig/api/system/objects/router-handler/routes/{routeid}

MCP Tools

forgerock-list-routes

ForgeRock List routes

read-only idempotent

forgerock-create-route

ForgeRock Create a route

forgerock-get-route

ForgeRock Get a route

read-only idempotent

forgerock-update-route

ForgeRock Update a route

idempotent

forgerock-delete-route

ForgeRock Delete a route

idempotent

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: ForgeRock Identity Gateway API — Routes
  description: 'ForgeRock Identity Gateway API — Routes. 5 operations. Lead operation: ForgeRock List routes. Self-contained
    Naftiko capability covering one Forgerock business surface.'
  tags:
  - Forgerock
  - Routes
  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-routes
    baseUri: https://{deployment}/ig
    description: ForgeRock Identity Gateway API — Routes business capability. Self-contained, no shared references.
    resources:
    - name: openig-api-system-objects-router-handler-routes
      path: /openig/api/system/objects/router-handler/routes
      operations:
      - name: listroutes
        method: GET
        description: ForgeRock List routes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: _queryFilter
          in: query
          type: string
          description: CREST query filter for routes
      - name: createroute
        method: POST
        description: ForgeRock Create a route
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: openig-api-system-objects-router-handler-routes-routeId
      path: /openig/api/system/objects/router-handler/routes/{routeId}
      operations:
      - name: getroute
        method: GET
        description: ForgeRock Get a route
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeId
          in: path
          type: string
          description: The route identifier
          required: true
      - name: updateroute
        method: PUT
        description: ForgeRock Update a route
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeId
          in: path
          type: string
          description: The route identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteroute
        method: DELETE
        description: ForgeRock Delete a route
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeId
          in: path
          type: string
          description: The route identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.FORGEROCK_API_KEY}}'
  exposes:
  - type: rest
    namespace: identity-gateway-routes-rest
    port: 8080
    description: REST adapter for ForgeRock Identity Gateway API — Routes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/openig/api/system/objects/router-handler/routes
      name: openig-api-system-objects-router-handler-routes
      description: REST surface for openig-api-system-objects-router-handler-routes.
      operations:
      - method: GET
        name: listroutes
        description: ForgeRock List routes
        call: identity-gateway-routes.listroutes
        with:
          _queryFilter: rest._queryFilter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createroute
        description: ForgeRock Create a route
        call: identity-gateway-routes.createroute
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/openig/api/system/objects/router-handler/routes/{routeid}
      name: openig-api-system-objects-router-handler-routes-routeid
      description: REST surface for openig-api-system-objects-router-handler-routes-routeId.
      operations:
      - method: GET
        name: getroute
        description: ForgeRock Get a route
        call: identity-gateway-routes.getroute
        with:
          routeId: rest.routeId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateroute
        description: ForgeRock Update a route
        call: identity-gateway-routes.updateroute
        with:
          routeId: rest.routeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteroute
        description: ForgeRock Delete a route
        call: identity-gateway-routes.deleteroute
        with:
          routeId: rest.routeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: identity-gateway-routes-mcp
    port: 9090
    transport: http
    description: MCP adapter for ForgeRock Identity Gateway API — Routes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: forgerock-list-routes
      description: ForgeRock List routes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-gateway-routes.listroutes
      with:
        _queryFilter: tools._queryFilter
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-create-route
      description: ForgeRock Create a route
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: identity-gateway-routes.createroute
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-get-route
      description: ForgeRock Get a route
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: identity-gateway-routes.getroute
      with:
        routeId: tools.routeId
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-update-route
      description: ForgeRock Update a route
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: identity-gateway-routes.updateroute
      with:
        routeId: tools.routeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: forgerock-delete-route
      description: ForgeRock Delete a route
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: identity-gateway-routes.deleteroute
      with:
        routeId: tools.routeId
      outputParameters:
      - type: object
        mapping: $.