ForgeRock

ForgeRock Objects API

Inspect live IG configuration objects

Documentation GitHub OpenAPI

Operations 2

GET /openig/api/system/objects ForgeRock List configuration objects #

GET /openig/api/system/objects/{objectType}/{objectId} ForgeRock Get a configuration object #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/forgerock-objects-api"

All apis

curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: ForgeRock Identity Gateway Objects API
  description: REST API for ForgeRock Identity Gateway (IG) providing route management, monitoring, and administration. IG acts as a reverse proxy that enforces security and access control for web applications, APIs, and microservices, integrating them with the ForgeRock Identity Platform.
  version: 7.3.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: identity-gateway
servers:
- url: https://{deployment}/ig
  description: ForgeRock Identity Gateway server
  variables:
    deployment:
      default: ig.example.com
      description: The IG deployment hostname
security:
- bearerAuth: []
tags:
- name: Objects
  description: Inspect live IG configuration objects
paths:
  /openig/api/system/objects:
    get:
      operationId: listObjects
      summary: ForgeRock List configuration objects
      description: List all live configuration objects in the IG runtime, including routes, handlers, filters, and decorators currently loaded.
      tags:
      - Objects
      parameters:
      - name: _queryFilter
        in: query
        description: CREST query filter
        schema:
          type: string
      responses:
        '200':
          description: List of configuration objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectList'
        '403':
          description: Forbidden - administrative access required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /openig/api/system/objects/{objectType}/{objectId}:
    get:
      operationId: getObject
      summary: ForgeRock Get a configuration object
      description: Retrieve details of a specific live configuration object from the IG runtime.
      tags:
      - Objects
      parameters:
      - name: objectType
        in: path
        required: true
        description: Type of the configuration object
        schema:
          type: string
          enum:
          - Router
          - Route
          - Handler
          - Filter
          - Chain
      - name: objectId
        in: path
        required: true
        description: Identifier of the configuration object
        schema:
          type: string
      responses:
        '200':
          description: Configuration object details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigObject'
        '404':
          description: Object not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ConfigObject:
      type: object
      description: A live configuration object in the IG runtime
      properties:
        _id:
          type: string
        type:
          type: string
          description: Object type (Router, Handler, Filter, etc.)
        name:
          type: string
        config:
          type: object
          description: Object configuration
    ObjectList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/ConfigObject'
        resultCount:
          type: integer
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token for administrative operations