ForgeRock Studio API

openapi: 3.2.0
info:
  title: ForgeRock Identity Gateway Studio 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: Studio
  description: IG Studio route design endpoints
paths:
  /openig/api/studio/routes:
    get:
      operationId: listStudioRoutes
      summary: ForgeRock List studio routes
      description: List routes available in the IG Studio interface for visual editing and management.
      tags:
      - Studio
      responses:
        '200':
          description: List of routes in Studio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteList'
    post:
      operationId: createStudioRoute
      summary: ForgeRock Create a route via Studio
      description: Create a new route through the IG Studio API with a simplified configuration format.
      tags:
      - Studio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
      responses:
        '201':
          description: Route created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
components:
  schemas:
    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
    RouteList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Route'
        resultCount:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token for administrative operations