{ "info": { "_postman_id": "adad8159-981d-49a9-ab7e-2be430f51417", "name": "Coveo Activity Activities Organizations 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:30:17.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "lastUpdatedBy": "35240", "uid": "35240-adad8159-981d-49a9-ab7e-2be430f51417" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "configuration", "item": [ { "name": "servingExperiment", "item": [ { "name": "Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default.", "id": "de64b05c-1d5f-4816-a7ce-eec3954c1532", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/configuration/servingExperiment?allowed=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "configuration", "servingExperiment" ], "query": [ { "description": "(Required) Whether serving experiments are allowed", "key": "allowed", "value": "" } ], "variable": [ { "id": "32d0ac35-ccad-40bd-a77e-bdd1d59cae35", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] } }, "response": [ { "id": "04364ef9-8ec1-48e6-9c29-7afef0b86ba5", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/configuration/servingExperiment?allowed=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "configuration", "servingExperiment" ], "query": [ { "description": "(Required) Whether serving experiments are allowed", "key": "allowed", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-04364ef9-8ec1-48e6-9c29-7afef0b86ba5" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-de64b05c-1d5f-4816-a7ce-eec3954c1532" } ], "id": "247549b4-5071-4ea2-a0df-36c394f15495", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-247549b4-5071-4ea2-a0df-36c394f15495" } ], "id": "593f05c7-db4e-4ec4-845f-17299458a5c2", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-593f05c7-db4e-4ec4-845f-17299458a5c2" }, { "name": "resume", "item": [ { "name": "Resume Organization", "id": "b18674e7-101a-4904-ba49-31811089820e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/resume", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "resume" ], "variable": [ { "id": "34fe2ced-4183-4053-b913-02eba7b2e634", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Resumes a paused [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "49daa00f-33c1-489e-a58c-5977b38384e9", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/resume", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "resume" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-49daa00f-33c1-489e-a58c-5977b38384e9" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-b18674e7-101a-4904-ba49-31811089820e" } ], "id": "10efa501-c070-4ef4-bca5-649f867e75ee", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-10efa501-c070-4ef4-bca5-649f867e75ee" }, { "name": "launchprovisioning", "item": [ { "name": "Provision Organization", "id": "3dafc80e-f7df-459b-9247-ae4bea39b9b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/launchprovisioning", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "launchprovisioning" ], "variable": [ { "id": "96121cba-de0d-4d1a-b8c5-e4c324d17893", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Launches the provisioning of an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "533c8a51-c563-4359-bb80-413be972200a", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/launchprovisioning", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "launchprovisioning" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-533c8a51-c563-4359-bb80-413be972200a" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-3dafc80e-f7df-459b-9247-ae4bea39b9b8" } ], "id": "888ce900-782b-44d0-bd9e-313e0b45cc89", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-888ce900-782b-44d0-bd9e-313e0b45cc89" }, { "name": "status", "item": [ { "name": "Show Organization Status", "id": "60bd3d67-4a6b-43e1-92a4-b3924e382ce9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "status" ], "variable": [ { "id": "21f1fed9-9f10-4351-92d4-11bc04da4de4", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Shows the status of an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "bbba9a1f-b55f-40a7-86df-857038f97573", "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/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "status" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"HEALTHY\",\n \"lifeCycleState\": \"ACTIVE\",\n \"errorCodes\": [\n \"PAUSING_FAILED\",\n \"PAUSING_FAILED\"\n ],\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"HEALTHY\"\n },\n \"pauseState\": \"IDLE\",\n \"readOnly\": false,\n \"supportActivated\": \"\",\n \"paused\": \"\",\n \"resumable\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-bbba9a1f-b55f-40a7-86df-857038f97573" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-60bd3d67-4a6b-43e1-92a4-b3924e382ce9" } ], "id": "a580b4e6-4d9b-402e-9409-1a0ece3e76eb", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-a580b4e6-4d9b-402e-9409-1a0ece3e76eb" }, { "name": "authentication", "item": [ { "name": "saml", "item": [ { "name": "{id}", "item": [ { "name": "Loads a Single SAML Authentication from an Organization", "id": "c30cc26f-9128-4ef8-bc53-babff07dd042", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "id": "e35f9d15-af80-47b1-927e-caa63bec3529", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "2be279a1-6a4c-40a4-a3f7-b338c38ac7ba", "key": "id", "value": "", "description": "(Required) The SAML authentication ID" } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "8753f5fe-234c-4787-b20b-0b9127a12b67", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"expiration\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SAML\",\n \"secret\": \"\",\n \"enforceTrustedUris\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"provider\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-8753f5fe-234c-4787-b20b-0b9127a12b67" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-c30cc26f-9128-4ef8-bc53-babff07dd042" }, { "name": "Updates a SAML Authentication in an Organization", "id": "05495fcf-aaf0-4015-9ba5-054a8ea5b2c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "id": "7fb10d37-5b17-495b-b70b-4cf1af160f87", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "324262b7-39dd-4538-9608-4fbd354eb066", "key": "id", "value": "", "description": "(Required) The SAML authentication ID" } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "4fd89c9b-5d0a-4b84-b4a5-acaab8991be9", "name": "No response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-4fd89c9b-5d0a-4b84-b4a5-acaab8991be9" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-05495fcf-aaf0-4015-9ba5-054a8ea5b2c4" }, { "name": "Deletes a SAML Authentication from an Organization", "id": "9b62f329-234d-4111-802d-36f32f8b9af4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "id": "59fe81e5-ccdc-43b0-8bab-a8b3c4a73aa8", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "fdc63a34-6c60-4bdc-8d6d-b24f49770406", "key": "id", "value": "", "description": "(Required) The SAML authentication ID" } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "78aa0b3f-7f19-4a33-843b-4b1fd104c79f", "name": "No response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-78aa0b3f-7f19-4a33-843b-4b1fd104c79f" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-9b62f329-234d-4111-802d-36f32f8b9af4" } ], "id": "ccd4880b-1e95-40a2-912d-a1d9d871db08", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-ccd4880b-1e95-40a2-912d-a1d9d871db08" }, { "name": "Lists the SAML Authentications for an Organization", "id": "efce451f-f44b-412c-a20a-7ec1252cc2c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml" ], "variable": [ { "id": "f99c620f-1e8c-430c-b382-68cd9b48eacd", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "a8bccccb-c173-47d2-ba9f-6f4fb7607f83", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SAML\",\n \"secret\": \"\",\n \"enforceTrustedUris\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"provider\": \"\"\n },\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SAML\",\n \"secret\": \"\",\n \"enforceTrustedUris\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"provider\": \"\"\n }\n]", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-a8bccccb-c173-47d2-ba9f-6f4fb7607f83" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-efce451f-f44b-412c-a20a-7ec1252cc2c2" }, { "name": "Creates a New SAML Authentication in an Organization", "id": "625d607e-d133-4e9a-bee8-cd028b35624e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml" ], "variable": [ { "id": "64b1aecd-a353-4fdd-b986-fbca4bfc6dd3", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "7a6b4855-5c8a-49fa-ad24-dee2c6223f39", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/saml", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "saml" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7a6b4855-5c8a-49fa-ad24-dee2c6223f39" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-625d607e-d133-4e9a-bee8-cd028b35624e" } ], "id": "d0c1815d-a005-4415-94cb-cd57bd7ade12", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-d0c1815d-a005-4415-94cb-cd57bd7ade12" }, { "name": "sharepoint", "item": [ { "name": "{id}", "item": [ { "name": "Get SharePoint Claims Authentication Provider", "id": "0a0e30e6-745c-4b4f-9790-f361e5536e37", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "id": "3df535af-d2f5-4fdb-80e3-c81782afa064", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "267a13f6-9df5-4fc0-8948-639bdbe7220c", "key": "id", "value": "", "description": "(Required) The unique identifier of the target SharePoint claims authentication provider." } ] }, "description": "Retrieves a single SharePoint claims authentication provider in a Coveo Cloud organization\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "defda1f2-7024-4fe1-af54-25fc6095bad7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"expiration\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SharePoint\",\n \"provider\": \"\",\n \"secret\": \"\",\n \"uri\": \"\",\n \"enforceTrustedUris\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-defda1f2-7024-4fe1-af54-25fc6095bad7" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-0a0e30e6-745c-4b4f-9790-f361e5536e37" }, { "name": "Update SharePoint Claims Authentication Provider", "id": "6a9a8ff0-ab28-4c2b-b10f-2eb4a484b5ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "id": "426a4843-fbe7-4b5e-822b-1936e960920e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "6afdbda7-6eaf-4d27-9d81-db745537c68f", "key": "id", "value": "", "description": "(Required) The unique identifier of the target SharePoint claims authentication provider." } ] }, "description": "Modifies an existing SharePoint claims authentication provider in a Coveo Cloud organization.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "8d92081c-f92f-471d-9e12-494ad5ac4783", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-8d92081c-f92f-471d-9e12-494ad5ac4783" }, { "id": "a8623606-43c0-4c96-a8e8-45f403f7fb51", "name": "No content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-a8623606-43c0-4c96-a8e8-45f403f7fb51" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-6a9a8ff0-ab28-4c2b-b10f-2eb4a484b5ef" }, { "name": "Delete SharePoint Claims Authentication Provider", "id": "11e5c00c-49e7-4048-b4b4-3fd31a6417a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "id": "04abd5e2-6571-4279-acd8-afedcc2bfa8b", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "b59febf4-a877-4247-b4dd-221b52a00005", "key": "id", "value": "", "description": "(Required) The unique identifier of the target SharePoint claims authentication provider." } ] }, "description": "Removes an existing SharePoint claims authentication provider from a Coveo Cloud organization.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "2c7125d3-8500-44a9-b473-96161415c01f", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-2c7125d3-8500-44a9-b473-96161415c01f" }, { "id": "5b0f09e0-4163-4113-8a57-3defdaabf650", "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/authentication/sharepoint/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-5b0f09e0-4163-4113-8a57-3defdaabf650" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-11e5c00c-49e7-4048-b4b4-3fd31a6417a6" } ], "id": "639c47b0-ad69-4b8a-bc40-1e561fdc6556", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-639c47b0-ad69-4b8a-bc40-1e561fdc6556" }, { "name": "List SharePoint Claims Authentication Providers", "id": "90ab6b58-1859-4823-a0af-11305ab0cc3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint" ], "variable": [ { "id": "2c008a27-b8a7-48d2-9782-9f96f933004d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "Gets all SharePoint claims authentication providers in a Coveo Cloud organization.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "2a3928d8-1ec4-4de6-9d59-7ae48af89d6c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SharePoint\",\n \"provider\": \"\",\n \"secret\": \"\",\n \"uri\": \"\",\n \"enforceTrustedUris\": \"\"\n },\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SharePoint\",\n \"provider\": \"\",\n \"secret\": \"\",\n \"uri\": \"\",\n \"enforceTrustedUris\": \"\"\n }\n]", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-2a3928d8-1ec4-4de6-9d59-7ae48af89d6c" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-90ab6b58-1859-4823-a0af-11305ab0cc3e" }, { "name": "Create SharePoint Claims Authentication Provider", "id": "464b4775-6b0b-4cca-a177-c5654beee969", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint" ], "variable": [ { "id": "4ac91c34-a8ec-4d89-9208-4eef61d89c23", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "Configures a new SharePoint claims authentication provider in a Coveo Cloud organization, allowing you to implement claims authentication in a search page (see [Claims Authentication](https://docs.coveo.com/en/113)).\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "0eac5f74-504a-4134-bd02-4c71ad75c301", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-0eac5f74-504a-4134-bd02-4c71ad75c301" }, { "id": "ebec8a1b-88e6-4b85-8e8b-e5619c9e11eb", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiration\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"uri\": \"\",\n \"secret\": \"\",\n \"enforceTrustedUris\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/sharepoint", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "sharepoint" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-ebec8a1b-88e6-4b85-8e8b-e5619c9e11eb" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-464b4775-6b0b-4cca-a177-c5654beee969" } ], "id": "527b38c6-b08f-4347-8409-80c815146be4", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-527b38c6-b08f-4347-8409-80c815146be4" }, { "name": "trusteduris", "item": [ { "name": "recentuntrusted", "item": [ { "name": "List Recently Seen Search Page URIs That Were Not Trusted.", "id": "9ef55d6b-6832-4a09-9c3a-6eb550aef23e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris/recentuntrusted?page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris", "recentuntrusted" ], "query": [ { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "id": "cfce7615-f09a-4eb3-9ed0-829ee3732216", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "Lists URI that were recently seen during SSO but that were not trusted. The last 100 URI are kept for 7 days.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "03b9b558-9981-4cad-bd64-d7858306f8a5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris/recentuntrusted?page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris", "recentuntrusted" ], "query": [ { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"uriPrefix\": \"\",\n \"date\": \"\"\n },\n {\n \"uriPrefix\": \"\",\n \"date\": \"\"\n }\n ],\n \"totalCount\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-03b9b558-9981-4cad-bd64-d7858306f8a5" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-9ef55d6b-6832-4a09-9c3a-6eb550aef23e" } ], "id": "784db5d7-62dc-44e6-8458-edfad22851af", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-784db5d7-62dc-44e6-8458-edfad22851af" }, { "name": "{id}", "item": [ { "name": "Delete Trusted Search Page URI", "id": "feff57bf-5773-4eee-bba2-517564fb86aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris", ":id" ], "variable": [ { "id": "9d8bb370-e837-4dd2-bc6e-9957b467776d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." }, { "id": "a922c9c4-34f1-4f42-bc70-519049244834", "key": "id", "value": "", "description": "(Required) The unique identifier of the trusted search page URI entry to delete." } ] }, "description": "Removes a trusted search page URI entry from a specific Coveo Cloud organization.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "d4590487-f94d-4766-a36b-2ee7b782fd75", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-d4590487-f94d-4766-a36b-2ee7b782fd75" }, { "id": "5053af67-084b-491f-b306-7db1e03ec7d9", "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/authentication/trusteduris/:id", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris", ":id" ], "variable": [ { "key": "organizationId" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-5053af67-084b-491f-b306-7db1e03ec7d9" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-feff57bf-5773-4eee-bba2-517564fb86aa" } ], "id": "0d69e4a7-8787-4df4-ab66-fc18a5ba7012", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-0d69e4a7-8787-4df4-ab66-fc18a5ba7012" }, { "name": "List Trusted Search Page URIs", "id": "e2ba31aa-2980-4e3f-bc7a-f161e8ff9957", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris?page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris" ], "query": [ { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "id": "836a35c8-bd2e-4780-a1c8-2ea67385ca4d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "Gets all existing trusted search page URI entries in a specific Coveo Cloud organization.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "e2c05e23-b6ec-4267-a657-b1d8ed5e871e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris?page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris" ], "query": [ { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"uriPrefix\": \"\"\n },\n {\n \"id\": \"\",\n \"uriPrefix\": \"\"\n }\n ],\n \"totalCount\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-e2c05e23-b6ec-4267-a657-b1d8ed5e871e" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-e2ba31aa-2980-4e3f-bc7a-f161e8ff9957" }, { "name": "Add Trusted Search Page URI", "id": "7839a59c-db43-4e55-8ea0-a3dace91235a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trustedUri\": {\n \"uriPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris" ], "variable": [ { "id": "92b81121-87eb-43d9-a377-5d16bfa3a3a9", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "Creates a new trusted search page URI entry in a specific Coveo Cloud organization. Any search page whose URI begins with that prefix will be allowed to use the SAML SSO provider of that organization as a means of authentication. \n**Notes:** \n- No URI is trusted by default. \n- Creating a trusted search page URI entry with the empty string will result in **all** URIs being trusted, which is not recommended.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "a93ca762-ab8b-41f8-82bd-be69f8f65156", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"trustedUri\": {\n \"uriPrefix\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication/trusteduris", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication", "trusteduris" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"trustedUri\": {\n \"id\": \"\",\n \"uriPrefix\": \"\"\n }\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-a93ca762-ab8b-41f8-82bd-be69f8f65156" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7839a59c-db43-4e55-8ea0-a3dace91235a" } ], "id": "fe652f5b-0db1-44d3-821d-e3179ff65f18", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-fe652f5b-0db1-44d3-821d-e3179ff65f18" }, { "name": "Lists All Authentication Providers for an Organization", "id": "caaed48f-a6ef-4c0f-9668-3ccdd6c9c6c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication" ], "variable": [ { "id": "542c8a11-cf64-4973-8d99-5e285f514a59", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization." } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "415d2422-bd06-418b-b4bf-6f0e2712c9a7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/authentication", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "authentication" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SAML\",\n \"secret\": \"\",\n \"enforceTrustedUris\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"provider\": \"\"\n },\n {\n \"expiration\": \"\",\n \"id\": \"\",\n \"metadata\": \"\",\n \"name\": \"\",\n \"organization\": \"\",\n \"protocol\": \"SAML\",\n \"secret\": \"\",\n \"enforceTrustedUris\": \"\",\n \"relyingPartyIdentifier\": \"\",\n \"assertionConsumerServiceUrl\": \"\",\n \"provider\": \"\"\n }\n]", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-415d2422-bd06-418b-b4bf-6f0e2712c9a7" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-caaed48f-a6ef-4c0f-9668-3ccdd6c9c6c7" } ], "id": "12dd691c-7362-4a2b-8e56-8027c1f7bd69", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-12dd691c-7362-4a2b-8e56-8027c1f7bd69" }, { "name": "Show Organization", "id": "7d71c9fd-2eb7-4022-9988-7fd4d3507f47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId?additionalFields=&additionalFields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "query": [ { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" }, { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" } ], "variable": [ { "id": "71410365-8c5d-406e-b17b-63d84a096d9e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Shows an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "dd727fc5-8f7d-410e-b435-1f3ebbab55cd", "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?additionalFields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "query": [ { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"createdDate\": \"\",\n \"license\": {\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"connectors\": [\n {\n \"type\": \"SITEMAP\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"PRIVATE\",\n \"SECURED\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"REBUILD\",\n \"scheduleFrequencies\": [\n \"MINUTELY\",\n \"WEEKLY\"\n ]\n },\n {\n \"refreshType\": \"SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR\",\n \"scheduleFrequencies\": [\n \"MONTHLY\",\n \"DAILY\"\n ]\n }\n ]\n },\n {\n \"type\": \"FILE\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"SECURED\",\n \"SECURED\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED\",\n \"scheduleFrequencies\": [\n \"DAILY\",\n \"DAILY\"\n ]\n },\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED\",\n \"scheduleFrequencies\": [\n \"MINUTELY\",\n \"MONTHLY\"\n ]\n }\n ]\n }\n ],\n \"createdDate\": \"\",\n \"department\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"SOON_TO_BE_EXPIRED\"\n },\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"ACTIVE\"\n }\n ],\n \"expirationDate\": \"\",\n \"expirationStatus\": \"EXPIRED\",\n \"indexBackupType\": \"FULL\",\n \"indexType\": \"ON_PREMISES\",\n \"machineLearningModels\": {\n \"sit_d\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n },\n \"eae\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n },\n \"non_9a\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n },\n \"veniam00b\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n }\n },\n \"monitoringLevel\": \"STRATEGIC_MONITORING\",\n \"productEdition\": \"FREE\",\n \"productName\": \"DYNAMICS\",\n \"productType\": \"TRIAL\",\n \"properties\": {\n \"ex_5\": {},\n \"adipisicing58\": {}\n }\n },\n \"businessAnalytics\": {\n \"creationOrigin\": \"BUSINESS_CRM\",\n \"userCategory\": \"PARTNER\",\n \"trackingAllowed\": \"\"\n },\n \"owner\": {\n \"email\": \"\"\n },\n \"readOnly\": \"\",\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"ERROR\"\n },\n \"adminUITimeoutInSeconds\": \"\",\n \"configuration\": {\n \"servingExperimentAllowed\": \"\"\n },\n \"organizationStatusModel\": {\n \"status\": \"ERROR\",\n \"lifeCycleState\": \"DELETING\",\n \"errorCodes\": [\n \"RESUMING_FAILED\",\n \"PAUSING_FAILED\"\n ],\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"HEALTHY\"\n },\n \"pauseState\": \"RESUMING\",\n \"readOnly\": false,\n \"supportActivated\": \"\",\n \"paused\": \"\",\n \"resumable\": \"\"\n }\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-dd727fc5-8f7d-410e-b435-1f3ebbab55cd" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7d71c9fd-2eb7-4022-9988-7fd4d3507f47" }, { "name": "Update Organization", "id": "32861d6c-c87d-4439-b9b2-b3a3fa8a1ae0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"owner\": {\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "variable": [ { "id": "65409828-2543-4ee2-af3e-f7841b58141f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Updates an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "de341a9c-e3fd-44d5-8a4b-c9be62bb47a8", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"owner\": {\n \"email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-de341a9c-e3fd-44d5-8a4b-c9be62bb47a8" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-32861d6c-c87d-4439-b9b2-b3a3fa8a1ae0" }, { "name": "Delete Organization", "id": "6ac81b2a-6f64-4470-b8f1-e79645202c51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "variable": [ { "id": "9b04f18c-cf17-4feb-b886-a14e77fd0fe5", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Delete an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "f404b284-0512-4a37-8055-5b78b4b47fb9", "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", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-f404b284-0512-4a37-8055-5b78b4b47fb9" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-6ac81b2a-6f64-4470-b8f1-e79645202c51" } ], "id": "2ccca103-541b-4dee-b44a-a2128e48c7bd", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-2ccca103-541b-4dee-b44a-a2128e48c7bd" }, { "name": "List Organizations", "id": "7745c96e-3397-4c41-9f83-08b5e9d6e8c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations?additionalFields=&additionalFields=&filter=&type=&sortBy=displayName&order=asc&page=0&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations" ], "query": [ { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" }, { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" }, { "description": "The free-form string to filter the returned list based on the values of the organization attributes. Using spaces is not recommended as it will prevent correct filtering.", "key": "filter", "value": "" }, { "description": "The type of organization to include in the returned list.
**Example:** `Test`
By default, organizations of all types may be included in the response.", "key": "type", "value": "" }, { "description": "The field to sort the returned organizations by.
**Example:** `createdDate`
**Default:** `displayName`", "key": "sortBy", "value": "displayName" }, { "description": "The `sortBy` order to list the organizations in.
**Allowed values:**
- `ASC`: Ascending order.
- `DESC`: Descending order.
**Example:** `DESC`
**Default:** `ASC`", "key": "order", "value": "asc" }, { "description": "The 0-based index number of the page to list.
**Example:** `5`
**Default:** `0`", "key": "page", "value": "0" }, { "description": "The maximum number of organizations to list per page.
**Example:** `50`
**Default:** `100`", "key": "perPage", "value": "100" } ] }, "description": "Lists all [organizations](https://docs.coveo.com/en/185/) you have access to." }, "response": [ { "id": "30ca45f2-d154-4a18-b444-4ecc0ddf214d", "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?additionalFields=&filter=&type=&sortBy=displayName&order=asc&page=0&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations" ], "query": [ { "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`", "key": "additionalFields", "value": "" }, { "description": "The free-form string to filter the returned list based on the values of the organization attributes. Using spaces is not recommended as it will prevent correct filtering.", "key": "filter", "value": "" }, { "description": "The type of organization to include in the returned list.
**Example:** `Test`
By default, organizations of all types may be included in the response.", "key": "type", "value": "" }, { "description": "The field to sort the returned organizations by.
**Example:** `createdDate`
**Default:** `displayName`", "key": "sortBy", "value": "displayName" }, { "description": "The `sortBy` order to list the organizations in.
**Allowed values:**
- `ASC`: Ascending order.
- `DESC`: Descending order.
**Example:** `DESC`
**Default:** `ASC`", "key": "order", "value": "asc" }, { "description": "The 0-based index number of the page to list.
**Example:** `5`
**Default:** `0`", "key": "page", "value": "0" }, { "description": "The maximum number of organizations to list per page.
**Example:** `50`
**Default:** `100`", "key": "perPage", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"createdDate\": \"\",\n \"license\": {\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"connectors\": [\n {\n \"type\": \"RSS\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"PRIVATE\",\n \"SHARED\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH_ENTITIES_NOT_UPDATED\",\n \"scheduleFrequencies\": [\n \"MINUTELY\",\n \"MONTHLY\"\n ]\n },\n {\n \"refreshType\": \"FULL_REFRESH\",\n \"scheduleFrequencies\": [\n \"HOURLY\",\n \"HOURLY\"\n ]\n }\n ]\n },\n {\n \"type\": \"CONFLUENCE2\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"PRIVATE\",\n \"SECURED\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"SECURITY_CACHE_REFRESH_ENTITIES_IN_ERROR\",\n \"scheduleFrequencies\": [\n \"HOURLY\",\n \"DAILY\"\n ]\n },\n {\n \"refreshType\": \"REBUILD\",\n \"scheduleFrequencies\": [\n \"DAILY\",\n \"HOURLY\"\n ]\n }\n ]\n }\n ],\n \"createdDate\": \"\",\n \"department\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"ACTIVE\"\n },\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"ACTIVE\"\n }\n ],\n \"expirationDate\": \"\",\n \"expirationStatus\": \"SOON_TO_BE_EXPIRED\",\n \"indexBackupType\": \"NONE\",\n \"indexType\": \"ELASTIC\",\n \"machineLearningModels\": {\n \"pariatur_f02\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n },\n \"occaecat_c\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n }\n },\n \"monitoringLevel\": \"REGULAR_MONITORING\",\n \"productEdition\": \"ENTERPRISE\",\n \"productName\": \"SERVICENOW\",\n \"productType\": \"INTERNAL\",\n \"properties\": {\n \"nostrud1\": {},\n \"irure83f\": {}\n }\n },\n \"businessAnalytics\": {\n \"creationOrigin\": \"UNKNOWN\",\n \"userCategory\": \"INTERNAL\",\n \"trackingAllowed\": \"\"\n },\n \"owner\": {\n \"email\": \"\"\n },\n \"readOnly\": \"\",\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"HEALTHY\"\n },\n \"adminUITimeoutInSeconds\": \"\",\n \"configuration\": {\n \"servingExperimentAllowed\": \"\"\n },\n \"organizationStatusModel\": {\n \"status\": \"HEALTHY\",\n \"lifeCycleState\": \"DELETING\",\n \"errorCodes\": [\n \"PAUSING_FAILED\",\n \"SEARCH_ERROR\"\n ],\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"HEALTHY\"\n },\n \"pauseState\": \"ACTIVE\",\n \"readOnly\": false,\n \"supportActivated\": \"\",\n \"paused\": \"\",\n \"resumable\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"createdDate\": \"\",\n \"license\": {\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"connectors\": [\n {\n \"type\": \"JIRA2\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"PRIVATE\",\n \"PRIVATE\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH\",\n \"scheduleFrequencies\": [\n \"DAILY\",\n \"MINUTELY\"\n ]\n },\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH\",\n \"scheduleFrequencies\": [\n \"HOURLY\",\n \"MONTHLY\"\n ]\n }\n ]\n },\n {\n \"type\": \"ZENDESK\",\n \"allowed\": \"\",\n \"sourceVisibilities\": [\n \"SHARED\",\n \"SHARED\"\n ],\n \"allowedSchedules\": [\n {\n \"refreshType\": \"SECURITY_PROVIDER_REFRESH\",\n \"scheduleFrequencies\": [\n \"HOURLY\",\n \"DAILY\"\n ]\n },\n {\n \"refreshType\": \"FULL_REFRESH\",\n \"scheduleFrequencies\": [\n \"WEEKLY\",\n \"DAILY\"\n ]\n }\n ]\n }\n ],\n \"createdDate\": \"\",\n \"department\": \"\",\n \"entitlements\": [\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"ACTIVE\"\n },\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"pricingUnit\": \"\",\n \"displayName\": \"\",\n \"productName\": \"\",\n \"useCase\": \"\",\n \"status\": \"\",\n \"itemLimit\": \"\",\n \"semanticSearchDocumentLimit\": \"\",\n \"semanticSearchQPMLimit\": \"\",\n \"lrpmLimit\": \"\",\n \"qpmLimit\": \"\",\n \"unlimitedQPM\": \"\",\n \"recommendationLimit\": \"\",\n \"unlimitedRecommendations\": \"\",\n \"userLimit\": \"\",\n \"unlimitedUsers\": \"\",\n \"passageRetrievalQPMLimit\": \"\",\n \"unlimitedPassageRetrievalQPM\": \"\",\n \"shouldShowInConsumptionDashboard\": \"\",\n \"expirationDate\": \"\",\n \"expirationStatus\": \"EXPIRED\"\n }\n ],\n \"expirationDate\": \"\",\n \"expirationStatus\": \"EXPIRED\",\n \"indexBackupType\": \"FULL\",\n \"indexType\": \"COVEO\",\n \"machineLearningModels\": {\n \"este9b\": {\n \"buildFrequency\": \"\",\n \"numberOfModelsLimit\": \"\",\n \"enabled\": \"\"\n }\n },\n \"monitoringLevel\": \"STRATEGIC_MONITORING\",\n \"productEdition\": \"PRO\",\n \"productName\": \"DYNAMICS\",\n \"productType\": \"ALLIANCE\",\n \"properties\": {\n \"consectetur_a2\": {}\n }\n },\n \"businessAnalytics\": {\n \"creationOrigin\": \"UNKNOWN\",\n \"userCategory\": \"PARTNER\",\n \"trackingAllowed\": \"\"\n },\n \"owner\": {\n \"email\": \"\"\n },\n \"readOnly\": \"\",\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"HEALTHY\"\n },\n \"adminUITimeoutInSeconds\": \"\",\n \"configuration\": {\n \"servingExperimentAllowed\": \"\"\n },\n \"organizationStatusModel\": {\n \"status\": \"ERROR\",\n \"lifeCycleState\": \"DELETING\",\n \"errorCodes\": [\n \"RESUMING_FAILED\",\n \"RESUMING_FAILED\"\n ],\n \"provisioningStatus\": {\n \"currentProvisioningProgress\": \"\",\n \"initialProvisioningDone\": \"\",\n \"lastProvisioningCompletedDate\": \"\",\n \"ongoing\": \"\",\n \"status\": \"ERROR\"\n },\n \"pauseState\": \"PAUSING_FAILED\",\n \"readOnly\": false,\n \"supportActivated\": \"\",\n \"paused\": \"\",\n \"resumable\": \"\"\n }\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-30ca45f2-d154-4a18-b444-4ecc0ddf214d" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7745c96e-3397-4c41-9f83-08b5e9d6e8c1" }, { "name": "Create Organization", "id": "f9fb0c43-775f-4778-9668-2dc99ef227ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations?name=&owner=&organizationTemplate=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations" ], "query": [ { "description": "(Required) The name to assign to the new organization.", "key": "name", "value": "" }, { "description": "The email of the owner to assign to the new organization.", "key": "owner", "value": "" }, { "description": "The name of the template to base the new organization on.", "key": "organizationTemplate", "value": "" } ] }, "description": "Creates an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "7c0066e2-6288-442c-b315-505917f87cc3", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations?name=&owner=&organizationTemplate=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations" ], "query": [ { "description": "(Required) The name to assign to the new organization.", "key": "name", "value": "" }, { "description": "The email of the owner to assign to the new organization.", "key": "owner", "value": "" }, { "description": "The name of the template to base the new organization on.", "key": "organizationTemplate", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"apiKey\": {\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ],\n \"id\": \"\",\n \"tokenId\": \"\",\n \"value\": \"\",\n \"organizationId\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"privileges\": [\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n },\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n }\n ],\n \"enabled\": \"\",\n \"createdDate\": \"\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"MZ\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"OFFICE365\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n }\n ],\n \"socialUser\": \"\",\n \"expired\": \"\",\n \"locked\": \"\",\n \"credentialsExpired\": \"\",\n \"enabled\": \"\",\n \"emailAliases\": [\n \"\",\n \"\"\n ],\n \"additionalInformation\": {\n \"dolor7\": \"\",\n \"cupidatat_\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"allowedIps\": [\n \"\",\n \"\"\n ],\n \"deniedIps\": [\n \"\",\n \"\"\n ],\n \"apiKeyTemplateId\": \"\",\n \"additionalConfiguration\": {\n \"commerce\": {\n \"catalogId\": \"\"\n },\n \"search\": {\n \"enforcedQueryPipelineConfiguration\": {\n \"searchHub\": \"\"\n },\n \"impersonationRestrictions\": {\n \"allowedUserIds\": [\n {\n \"name\": \"\",\n \"provider\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"provider\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"apiKeyQueryAuthentication\": [\n {\n \"name\": \"\",\n \"provider\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"provider\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"analytics\": {\n \"event\": {\n \"userId\": \"\",\n \"userDisplayName\": \"\"\n }\n }\n },\n \"lastUsedDate\": \"\",\n \"privacyLevel\": \"PUBLIC\",\n \"status\": \"DISABLED_FOR_INACTIVITY\",\n \"expirationDate\": \"\",\n \"lifetimeDuration\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"CRITICAL\",\n \"deactivationDate\": \"\",\n \"creationType\": \"MANUAL\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"CD\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"OFFICE365\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"SAML\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n }\n ],\n \"socialUser\": \"\",\n \"expired\": \"\",\n \"locked\": \"\",\n \"credentialsExpired\": \"\",\n \"enabled\": \"\",\n \"emailAliases\": [\n \"\",\n \"\"\n ],\n \"additionalInformation\": {\n \"dolore_adc\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"reasons\": [\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"GITHUB\",\n \"url\": \"\",\n \"createdDate\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n }\n ],\n \"createdDate\": \"\"\n },\n \"rotationEnabled\": \"\",\n \"rotationSecret\": \"\",\n \"disabled\": \"\",\n \"resourceId\": \"\"\n }\n}", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7c0066e2-6288-442c-b315-505917f87cc3" } ], "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-f9fb0c43-775f-4778-9668-2dc99ef227ca" } ], "id": "6bb5fdb3-a438-42eb-9cc9-9842693747f2", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-6bb5fdb3-a438-42eb-9cc9-9842693747f2" } ], "id": "7900dd33-83dc-482e-9a52-eeba3e63ce72", "createdAt": "2026-07-28T01:30:18.000Z", "updatedAt": "2026-07-28T01:30:18.000Z", "uid": "35240-7900dd33-83dc-482e-9a52-eeba3e63ce72" } ], "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" } ] }