{ "info": { "_postman_id": "f5af3a92-53b7-4095-a533-c79be8ee7250", "name": "ForgeRock Access Management Access Requests Routes API", "description": "REST API for ForgeRock Access Management (AM) providing authentication, authorization, session management, and policy evaluation. Supports OAuth 2.0 and OpenID Connect flows, authentication trees/journeys, policy-based authorization decisions, and realm management.\n\nContact Support:\n Name: ForgeRock", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "lastUpdatedBy": "35240", "uid": "35240-f5af3a92-53b7-4095-a533-c79be8ee7250" }, "item": [ { "name": "openig", "item": [ { "name": "api", "item": [ { "name": "system", "item": [ { "name": "objects", "item": [ { "name": "router-handler", "item": [ { "name": "routes", "item": [ { "name": "{routeId}", "item": [ { "name": "ForgeRock Get a route", "id": "2cc1e813-33d3-45a7-bf5c-730ddcc48226", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "id": "5942a6cb-66b9-4b26-8306-21fecd8a66fa", "key": "routeId", "value": "", "description": "(Required) The route identifier" } ] }, "description": "Retrieve a specific route configuration by its identifier." }, "response": [ { "id": "dc70ebea-af28-48d6-9af7-8c4d3d49c9f3", "name": "The route configuration", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-dc70ebea-af28-48d6-9af7-8c4d3d49c9f3" }, { "id": "20bcc63f-73a7-4d44-8e75-f444e6ba0c3b", "name": "Route not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-20bcc63f-73a7-4d44-8e75-f444e6ba0c3b" } ], "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-2cc1e813-33d3-45a7-bf5c-730ddcc48226" }, { "name": "ForgeRock Update a route", "id": "1d3bf6ab-9805-439a-a4a3-230ca105196c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "id": "8844ba4f-45b7-4678-ae1c-6371219dcc2a", "key": "routeId", "value": "", "description": "(Required) The route identifier" } ] }, "description": "Replace a route configuration. The updated route is immediately active." }, "response": [ { "id": "b221146d-8bab-45cb-9a47-2835dc9c3649", "name": "Route updated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-b221146d-8bab-45cb-9a47-2835dc9c3649" }, { "id": "f056a751-34c7-4eea-ab24-9d6d2f077d1b", "name": "Route not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-f056a751-34c7-4eea-ab24-9d6d2f077d1b" } ], "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-1d3bf6ab-9805-439a-a4a3-230ca105196c" }, { "name": "ForgeRock Delete a route", "id": "e05a1de0-05c5-44a5-9cae-ea79c224110a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "id": "b8a5b237-8c1c-45d9-ba80-409e7fda9810", "key": "routeId", "value": "", "description": "(Required) The route identifier" } ] }, "description": "Remove a route from the IG router. The route is immediately deactivated." }, "response": [ { "id": "e8d3d0ba-6cd2-4553-83d1-d43acbbd203d", "name": "Route deleted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-e8d3d0ba-6cd2-4553-83d1-d43acbbd203d" }, { "id": "f04fc659-70bf-4f5f-9903-bbf86c708d95", "name": "Route not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes/:routeId", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes", ":routeId" ], "variable": [ { "key": "routeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-f04fc659-70bf-4f5f-9903-bbf86c708d95" } ], "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-e05a1de0-05c5-44a5-9cae-ea79c224110a" } ], "id": "ed7242c3-d882-4a26-94b4-830cac1993ca", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-ed7242c3-d882-4a26-94b4-830cac1993ca" }, { "name": "ForgeRock List routes", "id": "91c4280a-33bb-4f76-901c-23399b2f3a95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes?_queryFilter=", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes" ], "query": [ { "description": "CREST query filter for routes", "key": "_queryFilter", "value": "" } ] }, "description": "List all routes currently loaded in the IG router, including their names, conditions, and status." }, "response": [ { "id": "9b73e9de-5659-4ad2-a5fa-bd16227ff561", "name": "List of routes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes?_queryFilter=", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes" ], "query": [ { "description": "CREST query filter for routes", "key": "_queryFilter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n }\n ],\n \"resultCount\": \"\"\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-9b73e9de-5659-4ad2-a5fa-bd16227ff561" } ], "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-91c4280a-33bb-4f76-901c-23399b2f3a95" }, { "name": "ForgeRock Create a route", "id": "b2d9f9d7-79fe-47b2-9456-046bebf47707", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes" ] }, "description": "Deploy a new route configuration to the IG router. The route is immediately active upon creation." }, "response": [ { "id": "1db2c0c3-1b9e-41fa-afd0-c510e0e16aa9", "name": "Route created and deployed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-1db2c0c3-1b9e-41fa-afd0-c510e0e16aa9" }, { "id": "061dbaff-4f7c-43c5-b674-dc5198d5a39b", "name": "Invalid route configuration", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"_id\": \"\",\n \"name\": \"\",\n \"condition\": \"\",\n \"handler\": \"\",\n \"baseURI\": \"\",\n \"heap\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"config\": {}\n }\n ],\n \"auditService\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/openig/api/system/objects/router-handler/routes", "host": [ "{{baseUrl}}" ], "path": [ "openig", "api", "system", "objects", "router-handler", "routes" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-061dbaff-4f7c-43c5-b674-dc5198d5a39b" } ], "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-b2d9f9d7-79fe-47b2-9456-046bebf47707" } ], "id": "37820c3e-4e2d-4098-8764-70b57fcfee3f", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-37820c3e-4e2d-4098-8764-70b57fcfee3f" } ], "id": "c3d01aa9-abae-4aad-8d4b-45030ed9784d", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-c3d01aa9-abae-4aad-8d4b-45030ed9784d" } ], "id": "cfaf7edc-c7bb-46c0-8282-93f4ad3d5f6d", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-cfaf7edc-c7bb-46c0-8282-93f4ad3d5f6d" } ], "id": "c5a22340-64fe-4967-8dab-17ec895e230d", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-c5a22340-64fe-4967-8dab-17ec895e230d" } ], "id": "cc650027-88c3-41ad-97fa-62a4c9c869cc", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-cc650027-88c3-41ad-97fa-62a4c9c869cc" } ], "id": "b778772e-9c1c-4fec-9ff6-8efd91f4b7c4", "createdAt": "2026-07-28T01:42:00.000Z", "updatedAt": "2026-07-28T01:42:00.000Z", "uid": "35240-b778772e-9c1c-4fec-9ff6-8efd91f4b7c4" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "iPlanetDirectoryPro", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "deployment", "value": "am.example.com" }, { "key": "baseUrl", "value": "https://{{deployment}}/am" } ] }