{ "info": { "_postman_id": "17f173ca-9b7b-4998-8bfc-1ec9079e768d", "name": "Coveo Activity Activities Group Realms API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "lastUpdatedBy": "35240", "uid": "35240-17f173ca-9b7b-4998-8bfc-1ec9079e768d" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "groups", "item": [ { "name": "{groupId}", "item": [ { "name": "realms", "item": [ { "name": "{realmId}", "item": [ { "name": "Show Realm", "id": "e5b6e0ef-fe71-4aa8-ba1c-3e9f95fc942f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms/:realmId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms", ":realmId" ], "variable": [ { "id": "639574f9-b1d7-4e37-a0f0-aa25b0817242", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "00d1d8ff-bd0d-44d1-94de-e1e7aaf16b26", "key": "groupId", "value": "", "description": "(Required) The unique identifier of the target [group](https://docs.coveo.com/en/2867/).
**Example:**`myorganization-bfghkjfjb674jh5egjk`" }, { "id": "5570c2a8-3d5c-4388-9040-ef33f0eab56d", "key": "realmId", "value": "", "description": "(Required) The unique identifier of the realm to show.
**Example:** `website-domain-coveo.com`" } ] }, "description": "Shows a realm of a [group](https://docs.coveo.com/en/2867/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "4d872ddb-da39-400f-aed3-91062c2986c2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms/:realmId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms", ":realmId" ], "variable": [ { "key": "organizationId" }, { "key": "groupId" }, { "key": "realmId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n}", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-4d872ddb-da39-400f-aed3-91062c2986c2" } ], "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-e5b6e0ef-fe71-4aa8-ba1c-3e9f95fc942f" }, { "name": "Destroy Realm", "id": "2c58c5fc-c7ad-4531-9fc5-40d1e7eda1d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms/:realmId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms", ":realmId" ], "variable": [ { "id": "6ed80ff5-180a-47ab-a25e-2da3a74c91d4", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "e82d1679-4bff-4af6-a93e-2334c6f4050d", "key": "groupId", "value": "", "description": "(Required) The unique identifier of the target [group](https://docs.coveo.com/en/2867/).
**Example:**`myorganization-bfghkjfjb674jh5egjk`" }, { "id": "0d293bc6-a72f-4dc9-8268-87c14d9e3f14", "key": "realmId", "value": "", "description": "(Required) The unique identifier of the realm to delete.
**Example:** `website-domain-coveo.com`" } ] }, "description": "Destroys a realm of a [group](https://docs.coveo.com/en/2867/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"{groupId}\"}\n```\n
" }, "response": [ { "id": "6cff5517-59e5-4fbc-8939-a01467deec6d", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms/:realmId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms", ":realmId" ], "variable": [ { "key": "organizationId" }, { "key": "groupId" }, { "key": "realmId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-6cff5517-59e5-4fbc-8939-a01467deec6d" } ], "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-2c58c5fc-c7ad-4531-9fc5-40d1e7eda1d2" } ], "id": "df741d95-fb2f-4cec-b92f-88b4ddd468de", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-df741d95-fb2f-4cec-b92f-88b4ddd468de" }, { "name": "List Realms", "id": "08ecb202-0d1e-48a1-9d1d-2f79e2ddd51e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms" ], "variable": [ { "id": "72d1db59-d3bf-456d-b10a-a07484a77434", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "88fbb66a-a933-4a18-8ee2-582ece554ebd", "key": "groupId", "value": "", "description": "(Required) The unique identifier of the target [group](https://docs.coveo.com/en/2867/).
**Example:**`myorganization-bfghkjfjb674jh5egjk`" } ] }, "description": "Lists the realms of a [group](https://docs.coveo.com/en/2867/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "ac582c6c-beb7-4fd4-9720-760ab51c1bbe", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms" ], "variable": [ { "key": "organizationId" }, { "key": "groupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"provider\": \"SALESFORCE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-ac582c6c-beb7-4fd4-9720-760ab51c1bbe" } ], "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-08ecb202-0d1e-48a1-9d1d-2f79e2ddd51e" }, { "name": "Add Realm", "id": "8da5436f-d949-4217-b25b-14b0f2e4c5e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms" ], "variable": [ { "id": "afc8b1d1-e652-47f7-8db1-32703a48ccad", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "f21f8975-a8c4-402a-8d07-838a964321d3", "key": "groupId", "value": "", "description": "(Required) The unique identifier of the target [group](https://docs.coveo.com/en/2867/).
**Example:**`myorganization-bfghkjfjb674jh5egjk`" } ] }, "description": "Adds a realm to a [group](https://docs.coveo.com/en/2867/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"{groupId}\"}\n```\n
" }, "response": [ { "id": "aea33d51-ea4d-4132-a73d-d4c83a80235e", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/groups/:groupId/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "groups", ":groupId", "realms" ], "variable": [ { "key": "organizationId" }, { "key": "groupId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n}", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-aea33d51-ea4d-4132-a73d-d4c83a80235e" } ], "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-8da5436f-d949-4217-b25b-14b0f2e4c5e3" } ], "id": "4f88b0af-2ae6-4d9c-a818-5c24febe314c", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-4f88b0af-2ae6-4d9c-a818-5c24febe314c" } ], "id": "93511c53-2837-4a7b-9660-0812af2a9c5f", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-93511c53-2837-4a7b-9660-0812af2a9c5f" } ], "id": "5387c48b-6733-4344-bddd-d8031f038b3e", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-5387c48b-6733-4344-bddd-d8031f038b3e" } ], "id": "89fa5631-4d47-4a99-9f6a-574a95092af1", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-89fa5631-4d47-4a99-9f6a-574a95092af1" } ], "id": "94f37bd1-a6e2-4f6a-b9d1-1c3c1a6a5a32", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-94f37bd1-a6e2-4f6a-b9d1-1c3c1a6a5a32" } ], "id": "bc383480-ba76-4eb3-a5d9-c3194122045c", "createdAt": "2026-07-28T01:28:39.000Z", "updatedAt": "2026-07-28T01:28:39.000Z", "uid": "35240-bc383480-ba76-4eb3-a5d9-c3194122045c" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }