{ "info": { "_postman_id": "c032fe3d-c608-477a-831f-7cbda8de992b", "name": "ForgeRock Access Management Access Requests Realms 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:41:56.000Z", "updatedAt": "2026-07-28T01:41:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-c032fe3d-c608-477a-831f-7cbda8de992b" }, "item": [ { "name": "json", "item": [ { "name": "global-config", "item": [ { "name": "realms", "item": [ { "name": "{realmName}", "item": [ { "name": "ForgeRock Get a realm", "id": "f2b8558b-40bf-4f18-b0e3-7ff30c1f3e8f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "id": "23b93007-b1dc-4508-af4e-b0dbdf6d106a", "key": "realmName", "value": "", "description": "(Required) The realm name" } ] }, "description": "Retrieve configuration for a specific realm." }, "response": [ { "id": "5479eb4f-c8bf-4658-889f-93098a659761", "name": "Realm configuration", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "key": "realmName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-5479eb4f-c8bf-4658-889f-93098a659761" }, { "id": "958201e1-3373-4092-85cc-596c05966c8b", "name": "Realm not found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "key": "realmName" } ] } }, "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:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-958201e1-3373-4092-85cc-596c05966c8b" } ], "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-f2b8558b-40bf-4f18-b0e3-7ff30c1f3e8f" }, { "name": "ForgeRock Update a realm", "id": "6fe40a00-bf95-467b-9114-0b229cac33c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "id": "2cb5dee8-1b39-48cd-8415-951ee2a1de01", "key": "realmName", "value": "", "description": "(Required) The realm name" } ] }, "description": "Update configuration for an existing realm." }, "response": [ { "id": "c50e678b-6e08-47b8-b6f3-4b174960954e", "name": "Realm updated", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "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 \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "key": "realmName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-c50e678b-6e08-47b8-b6f3-4b174960954e" } ], "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-6fe40a00-bf95-467b-9114-0b229cac33c6" }, { "name": "ForgeRock Delete a realm", "id": "c0273699-12e7-44b3-a9ea-65c6cafa0ad1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "id": "1d5283f7-00bc-4847-8404-36b8b9e4bcf2", "key": "realmName", "value": "", "description": "(Required) The realm name" } ] }, "description": "Delete a realm from the AM deployment." }, "response": [ { "id": "80cf031b-1903-4923-9dc4-08a79d7f5d7e", "name": "Realm deleted", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms/:realmName", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms", ":realmName" ], "variable": [ { "key": "realmName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-80cf031b-1903-4923-9dc4-08a79d7f5d7e" } ], "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-c0273699-12e7-44b3-a9ea-65c6cafa0ad1" } ], "id": "f5635efc-86ce-442e-9989-3b79870c6c00", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-f5635efc-86ce-442e-9989-3b79870c6c00" }, { "name": "ForgeRock List realms", "id": "8e2f9983-8203-4ff1-be71-78e9339c9a87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms?_queryFilter=", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms" ], "query": [ { "description": "CREST query filter for realms", "key": "_queryFilter", "value": "" } ] }, "description": "Query all configured realms in the AM deployment." }, "response": [ { "id": "b9022756-2ee3-4ba9-82e7-13e6a58721e3", "name": "List of realms", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "iPlanetDirectoryPro", "value": "" } ], "url": { "raw": "{{baseUrl}}/json/global-config/realms?_queryFilter=", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms" ], "query": [ { "description": "CREST query filter for realms", "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 \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"resultCount\": \"\"\n}", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-b9022756-2ee3-4ba9-82e7-13e6a58721e3" } ], "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-8e2f9983-8203-4ff1-be71-78e9339c9a87" }, { "name": "ForgeRock Create a realm", "id": "f2196263-4be4-4cff-8e14-944b09f12f70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/json/global-config/realms", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms" ] }, "description": "Create a new realm in the AM deployment." }, "response": [ { "id": "ac5a7bfb-3eef-42d8-bc6e-aa15751dec3a", "name": "Realm created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) CREST API version protocol header", "key": "Accept-API-Version", "value": "resource=2.0,protocol=1.0" }, { "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 \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/json/global-config/realms", "host": [ "{{baseUrl}}" ], "path": [ "json", "global-config", "realms" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"parentPath\": \"\",\n \"active\": \"\",\n \"aliases\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-ac5a7bfb-3eef-42d8-bc6e-aa15751dec3a" } ], "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-f2196263-4be4-4cff-8e14-944b09f12f70" } ], "id": "8932ceaa-b25b-4bd6-939c-a430c5033170", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-8932ceaa-b25b-4bd6-939c-a430c5033170" } ], "id": "594b3191-a184-49fc-9d64-e5a799beae04", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-594b3191-a184-49fc-9d64-e5a799beae04" } ], "id": "d2c17b98-cfbc-4dee-8b43-25b365ff621c", "createdAt": "2026-07-28T01:41:57.000Z", "updatedAt": "2026-07-28T01:41:57.000Z", "uid": "35240-d2c17b98-cfbc-4dee-8b43-25b365ff621c" } ], "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" } ] }