ForgeRock · Schema

Route

An IG route configuration

Access ManagementAuthenticationAuthorizationIdentity GovernanceIdentity ManagementOpenID Connect

Properties

Name Type Description
_id string Route identifier (derived from route name)
name string Human-readable route name
condition string Expression that determines when this route handles a request (e.g., "${find(request.uri.path, '/myapp')}")
handler object The handler that processes requests matching this route
baseURI string Base URI for the protected application
heap array Heap objects declared for this route
auditService object Audit service configuration for this route
View JSON Schema on GitHub

JSON Schema

forgerock-route-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Route",
  "title": "Route",
  "type": "object",
  "description": "An IG route configuration",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Route identifier (derived from route name)"
    },
    "name": {
      "type": "string",
      "description": "Human-readable route name"
    },
    "condition": {
      "type": "string",
      "description": "Expression that determines when this route handles a request (e.g., \"${find(request.uri.path, '/myapp')}\")"
    },
    "handler": {
      "description": "The handler that processes requests matching this route",
      "oneOf": [
        {
          "type": "string",
          "description": "Reference to a named handler"
        },
        {
          "type": "object",
          "description": "Inline handler configuration",
          "properties": {
            "type": {
              "type": "string",
              "description": "Handler type name"
            },
            "config": {
              "type": "object",
              "description": "Handler configuration"
            }
          }
        }
      ]
    },
    "baseURI": {
      "type": "string",
      "format": "uri",
      "description": "Base URI for the protected application"
    },
    "heap": {
      "type": "array",
      "description": "Heap objects declared for this route",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "config": {
            "type": "object"
          }
        }
      }
    },
    "auditService": {
      "type": "object",
      "description": "Audit service configuration for this route"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/forgerock-route"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.