{ "info": { "_postman_id": "3e1e8a37-c4e6-42ca-a054-4f75e30fa94e", "name": "Coveo Activity Activities Api Keys 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:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "lastUpdatedBy": "35240", "uid": "35240-3e1e8a37-c4e6-42ca-a054-4f75e30fa94e" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "apikeys", "item": [ { "name": "{sourceApiKeyId}", "item": [ { "name": "duplicate", "item": [ { "name": "Duplicate API Key", "id": "a39a7901-3a50-47cf-8c92-7d95e4e248fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"displayName\": \"\",\n \"description\": \"\",\n \"lifetimeDuration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:sourceApiKeyId/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":sourceApiKeyId", "duplicate" ], "variable": [ { "id": "a26554b8-ecfc-4f8d-9d7f-c918634d60d6", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "fcb4dc63-e642-4d63-a7c2-81654b1aeb6a", "key": "sourceApiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Duplicates and existing API key of an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "70fa877a-6585-49df-8ed9-0a1216f54b2a", "name": "Created", "originalRequest": { "method": "PUT", "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 \"displayName\": \"\",\n \"description\": \"\",\n \"lifetimeDuration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:sourceApiKeyId/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":sourceApiKeyId", "duplicate" ], "variable": [ { "key": "organizationId" }, { "key": "sourceApiKeyId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"WF\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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 \"nulla8d5\": \"\",\n \"eiusmod30\": \"\",\n \"fugiat0c\": \"\"\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\": \"PRIVATE\",\n \"status\": \"ENABLED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"MEDIUM\",\n \"deactivationDate\": \"\",\n \"creationType\": \"AUTOMATED\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"BV\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\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 \"cupidatat_7c\": \"\",\n \"eubeb\": \"\",\n \"commodo7\": \"\",\n \"eu_b\": \"\",\n \"Ut4\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"reasons\": [\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"GITHUB\",\n \"url\": \"\",\n \"createdDate\": \"\"\n }\n ],\n \"createdDate\": \"\"\n },\n \"rotationSecret\": \"\",\n \"resourceId\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-70fa877a-6585-49df-8ed9-0a1216f54b2a" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-a39a7901-3a50-47cf-8c92-7d95e4e248fb" } ], "id": "7ae303c0-6274-4965-b911-eab764680cc1", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-7ae303c0-6274-4965-b911-eab764680cc1" } ], "id": "d198119a-7e57-41d0-bfdc-82a4e87fb704", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-d198119a-7e57-41d0-bfdc-82a4e87fb704" }, { "name": "{apiKeyId}", "item": [ { "name": "disable", "item": [ { "name": "Disable API Key", "id": "550b3e56-f846-4896-9b36-bad5470505b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "disable" ], "variable": [ { "id": "b7296bd8-bd42-4aec-b45e-f23450203a48", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "0408c228-7db3-4338-b359-7dea2c3a7e7c", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Disables an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "6499e434-e2c8-4456-b12f-de1337231fee", "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/apikeys/:apiKeyId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "disable" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-6499e434-e2c8-4456-b12f-de1337231fee" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-550b3e56-f846-4896-9b36-bad5470505b7" } ], "id": "d4b4fc58-88b1-4887-abc3-f20f70dfe46c", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-d4b4fc58-88b1-4887-abc3-f20f70dfe46c" }, { "name": "activation", "item": [ { "name": "extend", "item": [ { "name": "Extend API Key Activation", "id": "3ac6a1ac-4113-4143-8d6b-9bae528da27f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId/activation/extend", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "activation", "extend" ], "variable": [ { "id": "1952c085-1e94-4259-88ea-f445ecae88a5", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "3dec7c49-7874-4ebc-9df7-f01abf5e9b8e", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Extend the activation of an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "8996bc21-f79e-4f77-beec-4722ec641a70", "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/apikeys/:apiKeyId/activation/extend", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "activation", "extend" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-8996bc21-f79e-4f77-beec-4722ec641a70" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-3ac6a1ac-4113-4143-8d6b-9bae528da27f" } ], "id": "f3e36268-c774-4153-a0ad-de11c49fedc8", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-f3e36268-c774-4153-a0ad-de11c49fedc8" } ], "id": "9827ad24-b278-4f3e-964a-4cb05e9451d9", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-9827ad24-b278-4f3e-964a-4cb05e9451d9" }, { "name": "activate", "item": [ { "name": "Activate API Key", "id": "20c6af14-8173-43a5-b9ad-a4802b694e77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId/activate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "activate" ], "variable": [ { "id": "e698c2a7-f56f-4b1c-a931-213bb4275d36", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "ace62b89-e993-4aef-a2af-13df392727c6", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Activates an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "a0becc12-e0ce-4c11-bfbd-a7288abaa9da", "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/apikeys/:apiKeyId/activate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId", "activate" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-a0becc12-e0ce-4c11-bfbd-a7288abaa9da" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-20c6af14-8173-43a5-b9ad-a4802b694e77" } ], "id": "049235e8-44aa-49e2-93c0-61412c2e5526", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-049235e8-44aa-49e2-93c0-61412c2e5526" }, { "name": "Show API Key", "id": "e1ac685c-fb39-41d9-89d6-b2a0bd22e48b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "id": "61396cf2-b6b1-4cbe-ac0e-5ac0c651f30f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "d1136482-7d6a-4b56-8922-9161d2bda08a", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`" } ] }, "description": "Shows an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "aecf4f28-f565-4f17-b045-b44b5764f2b2", "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/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"NR\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\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\": \"OFFICE365\",\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 \"est_f1c\": \"\",\n \"consequat_f0\": \"\"\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\": \"PRIVATE\",\n \"status\": \"SOON_TO_BE_EXPIRED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"CRITICAL\",\n \"deactivationDate\": \"\",\n \"creationType\": \"AUTOMATED\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"BS\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\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 \"in_33\": \"\",\n \"officia_fe\": \"\"\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 \"resourceId\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-aecf4f28-f565-4f17-b045-b44b5764f2b2" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-e1ac685c-fb39-41d9-89d6-b2a0bd22e48b" }, { "name": "Update API Key", "id": "bb5bfb55-0fb8-4143-afbc-f5ccb5372c5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\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 \"displayName\": \"\",\n \"description\": \"\",\n \"allowedIps\": [\n \"\",\n \"\"\n ],\n \"deniedIps\": [\n \"\",\n \"\"\n ],\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}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "id": "68e22bb0-7daa-4469-b962-36e9f1cd361b", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "0d0c5492-d870-448a-a7b0-eba95a47a3f2", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Updates an existing API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "49f80bdd-8f12-43d0-b0c2-c5c2aee29699", "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 \"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 \"displayName\": \"\",\n \"description\": \"\",\n \"allowedIps\": [\n \"\",\n \"\"\n ],\n \"deniedIps\": [\n \"\",\n \"\"\n ],\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}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-49f80bdd-8f12-43d0-b0c2-c5c2aee29699" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-bb5bfb55-0fb8-4143-afbc-f5ccb5372c5d" }, { "name": "Delete API Key", "id": "c3b49e51-8c53-4e4d-8a85-ab947de51069", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "id": "000ed16e-8eaf-4d8e-9f80-70869d9a35c7", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "f64a6b14-4e68-41c7-818b-94100629cd4c", "key": "apiKeyId", "value": "", "description": "(Required) The unique identifier of the API key.
**Example:** `t4hk287bfj5sg6wskg64ckk5a`
See [Getting the apiKeyId](https://docs.coveo.com/en/38/)." } ] }, "description": "Deletes an API key from an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "1aa78a74-d728-4db0-bfb1-7217ef42a2e3", "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/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "organizationId" }, { "key": "apiKeyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-1aa78a74-d728-4db0-bfb1-7217ef42a2e3" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-c3b49e51-8c53-4e4d-8a85-ab947de51069" } ], "id": "6414e0a5-a9af-49f3-9ae2-4543a669ada7", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-6414e0a5-a9af-49f3-9ae2-4543a669ada7" }, { "name": "disable", "item": [ { "name": "bulk", "item": [ { "name": "Disable Multiple API Keys", "id": "0e4780df-9e2e-408c-884e-9a4d52c5784b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/disable/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "disable", "bulk" ], "variable": [ { "id": "ede2ec4b-6a44-45b3-be35-f48a40e219d8", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Disables multiple API keys in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "17bf258e-afa8-48b8-88ac-5ea947fc630b", "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 \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/disable/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "disable", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-17bf258e-afa8-48b8-88ac-5ea947fc630b" }, { "id": "a030aa9f-261b-4c4d-b40a-630610cb46e3", "name": "Precondition Failed", "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 \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/disable/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "disable", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errorCode\": \"\",\n \"requestID\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-a030aa9f-261b-4c4d-b40a-630610cb46e3" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-0e4780df-9e2e-408c-884e-9a4d52c5784b" } ], "id": "beabbf7a-b37d-4143-b9a5-c2ea867fd302", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-beabbf7a-b37d-4143-b9a5-c2ea867fd302" } ], "id": "16b781d2-e3e8-4f6d-a598-8d58c5de9245", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-16b781d2-e3e8-4f6d-a598-8d58c5de9245" }, { "name": "activate", "item": [ { "name": "bulk", "item": [ { "name": "Activate API Keys", "id": "6f98820c-6c09-43c1-abde-4d04edc8b4cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/activate/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "activate", "bulk" ], "variable": [ { "id": "8bad0ac3-6c82-482b-ac4a-51e2497b9f13", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Activates multiple API keys in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "387a12d1-ebb0-464e-af60-855ce8f0bb2e", "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 \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/activate/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "activate", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-387a12d1-ebb0-464e-af60-855ce8f0bb2e" }, { "id": "fb93da17-daf3-4a1c-9249-0d81b0cc56c7", "name": "Precondition Failed", "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 \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/activate/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "activate", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errorCode\": \"\",\n \"requestID\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-fb93da17-daf3-4a1c-9249-0d81b0cc56c7" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-6f98820c-6c09-43c1-abde-4d04edc8b4cd" } ], "id": "48ce9dc8-5047-4829-b184-bb5670e2840d", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-48ce9dc8-5047-4829-b184-bb5670e2840d" } ], "id": "17b72084-af75-476a-a079-a2700a5a1b52", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-17b72084-af75-476a-a079-a2700a5a1b52" }, { "name": "rotate", "item": [ { "name": "Rotate API Key", "id": "563fc623-2875-4638-9b35-778df27f659a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"rotationSecret\": \"\",\n \"previousKeyExpirationPeriod\": \"\",\n \"newKeyExpirationPeriod\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/rotate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "rotate" ], "variable": [ { "id": "3938c0ef-3111-4cbe-a4ac-32509c9ef162", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Rotates an API key in an [organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "4ca25fde-747a-4858-b460-35cb72b0b61d", "name": "OK", "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 \"rotationSecret\": \"\",\n \"previousKeyExpirationPeriod\": \"\",\n \"newKeyExpirationPeriod\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/rotate", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "rotate" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"WF\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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 \"nulla8d5\": \"\",\n \"eiusmod30\": \"\",\n \"fugiat0c\": \"\"\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\": \"PRIVATE\",\n \"status\": \"ENABLED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"MEDIUM\",\n \"deactivationDate\": \"\",\n \"creationType\": \"AUTOMATED\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"BV\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\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 \"cupidatat_7c\": \"\",\n \"eubeb\": \"\",\n \"commodo7\": \"\",\n \"eu_b\": \"\",\n \"Ut4\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"reasons\": [\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"GITHUB\",\n \"url\": \"\",\n \"createdDate\": \"\"\n }\n ],\n \"createdDate\": \"\"\n },\n \"rotationSecret\": \"\",\n \"resourceId\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-4ca25fde-747a-4858-b460-35cb72b0b61d" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-563fc623-2875-4638-9b35-778df27f659a" } ], "id": "d11a0564-6712-409d-8d37-32fc51ca5691", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-d11a0564-6712-409d-8d37-32fc51ca5691" }, { "name": "delete", "item": [ { "name": "bulk", "item": [ { "name": "Delete API Keys", "id": "9fb7800e-6a17-4404-bff7-a7065fe287c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/delete/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "delete", "bulk" ], "variable": [ { "id": "bc13f22e-9b22-47b5-ace9-47683c26c0c3", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Deletes multiple API keys from an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"EDIT\",\"targetId\":\"{apiKeyId}\"}\n```\n
" }, "response": [ { "id": "82ab77b7-805f-4ef5-aba3-6421834234ec", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/delete/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "delete", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-82ab77b7-805f-4ef5-aba3-6421834234ec" }, { "id": "54b99c8b-9c21-4952-8237-ef8582558889", "name": "Precondition Failed", "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 \"\",\n \"\"\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys/delete/bulk", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys", "delete", "bulk" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errorCode\": \"\",\n \"requestID\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-54b99c8b-9c21-4952-8237-ef8582558889" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-9fb7800e-6a17-4404-bff7-a7065fe287c1" } ], "id": "a3255d94-863f-4f6e-8afd-a5a361fe7ed4", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-a3255d94-863f-4f6e-8afd-a5a361fe7ed4" } ], "id": "838b075f-e1eb-44d3-a135-11c2ff1e2b62", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-838b075f-e1eb-44d3-a135-11c2ff1e2b62" }, { "name": "List API Keys", "id": "0e375374-e245-42ec-9d0f-f6e0ae674747", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys?status=WITH_WARNING", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys" ], "query": [ { "description": "Optional filter for API key status", "key": "status", "value": "WITH_WARNING" } ], "variable": [ { "id": "dba548fb-4774-4795-8cb0-446e35fcf6ce", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the organization" } ] }, "description": "Lists all API keys in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "e6d221dc-b1ad-4ee4-9023-9732804ba6dc", "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/apikeys?status=WITH_WARNING", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys" ], "query": [ { "description": "Optional filter for API key status", "key": "status", "value": "WITH_WARNING" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"AL\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\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\": \"SALESFORCE_SANDBOX\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SAML\",\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 \"elit31\": \"\"\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\": \"PRIVATE\",\n \"status\": \"SOON_TO_BE_DISABLED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"HIGH\",\n \"deactivationDate\": \"\",\n \"creationType\": \"MANUAL\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"GM\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SAML\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\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 \"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 \"socialUser\": \"\",\n \"expired\": \"\",\n \"locked\": \"\",\n \"credentialsExpired\": \"\",\n \"enabled\": \"\",\n \"emailAliases\": [\n \"\",\n \"\"\n ],\n \"additionalInformation\": {\n \"sedbd\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"reasons\": [\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n }\n ],\n \"createdDate\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"JP\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"OFFICE365\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\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\": \"SAML\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\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 \"fugiat82\": \"\",\n \"commodof\": \"\"\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\": \"PRIVATE\",\n \"status\": \"DISABLED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"WARN\",\n \"deactivationDate\": \"\",\n \"creationType\": \"MANUAL\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"BB\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"EMAIL\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"SAML\",\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\": \"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 \"esse_5\": \"\",\n \"reprehenderitc6\": \"\",\n \"elit6\": \"\",\n \"est_5\": \"\",\n \"cillum_8\": \"\"\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 \"resourceId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-e6d221dc-b1ad-4ee4-9023-9732804ba6dc" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-0e375374-e245-42ec-9d0f-f6e0ae674747" }, { "name": "Create API Key", "id": "56b4ae7c-5e72-414a-8d92-dcdf1172f253", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\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 \"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 \"allowedIps\": [\n \"\",\n \"\"\n ],\n \"deniedIps\": [\n \"\",\n \"\"\n ],\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 \"lifetimeDuration\": \"\",\n \"overrideTemplatePrivileges\": [\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n },\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n }\n ],\n \"rotationEnabled\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys?apiKeyTemplateId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys" ], "query": [ { "description": "The unique identifier of the template on which to base the API key.", "key": "apiKeyTemplateId", "value": "" } ], "variable": [ { "id": "3ff1b217-528a-41ed-92d2-52d0935d4ae1", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "c3b2ab55-2765-40f2-aea9-0966935ca42d", "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 \"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 \"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 \"allowedIps\": [\n \"\",\n \"\"\n ],\n \"deniedIps\": [\n \"\",\n \"\"\n ],\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 \"lifetimeDuration\": \"\",\n \"overrideTemplatePrivileges\": [\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n },\n {\n \"type\": \"\",\n \"targetDomain\": \"\",\n \"targetId\": \"\",\n \"owner\": \"\"\n }\n ],\n \"rotationEnabled\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/apikeys?apiKeyTemplateId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "apikeys" ], "query": [ { "description": "The unique identifier of the template on which to base the API key.", "key": "apiKeyTemplateId", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\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 \"value\": \"\",\n \"id\": \"\",\n \"tokenId\": \"\",\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\": \"WF\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE_SANDBOX\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\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 \"nulla8d5\": \"\",\n \"eiusmod30\": \"\",\n \"fugiat0c\": \"\"\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\": \"PRIVATE\",\n \"status\": \"ENABLED\",\n \"expirationDate\": \"\",\n \"disabledDate\": \"\",\n \"activationDate\": \"\",\n \"exposureReport\": {\n \"apiKeyLoggerId\": \"\",\n \"severity\": \"MEDIUM\",\n \"deactivationDate\": \"\",\n \"creationType\": \"AUTOMATED\",\n \"createdBy\": {\n \"username\": \"\",\n \"name\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"emailConfirmed\": \"\",\n \"displayName\": \"\",\n \"country\": \"BV\",\n \"providerUsername\": \"\",\n \"providerUserId\": \"\",\n \"provider\": \"SALESFORCE\",\n \"samlIdentityProviderId\": \"\",\n \"realms\": [\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n },\n {\n \"member\": \"\",\n \"realm\": {\n \"id\": \"\",\n \"provider\": \"OFFICE365\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n \"realmModel\": {\n \"id\": \"\",\n \"provider\": \"GOOGLE\",\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 \"cupidatat_7c\": \"\",\n \"eubeb\": \"\",\n \"commodo7\": \"\",\n \"eu_b\": \"\",\n \"Ut4\": \"\"\n },\n \"lastUsedDate\": \"\"\n },\n \"reasons\": [\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"MANUAL\",\n \"url\": \"\",\n \"createdDate\": \"\"\n },\n {\n \"id\": \"\",\n \"reason\": \"\",\n \"source\": \"GITHUB\",\n \"url\": \"\",\n \"createdDate\": \"\"\n }\n ],\n \"createdDate\": \"\"\n },\n \"rotationSecret\": \"\",\n \"resourceId\": \"\"\n}", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-c3b2ab55-2765-40f2-aea9-0966935ca42d" } ], "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-56b4ae7c-5e72-414a-8d92-dcdf1172f253" } ], "id": "c18651f3-3a55-4112-ac76-660a008e002f", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-c18651f3-3a55-4112-ac76-660a008e002f" } ], "id": "a1317ee8-1be3-4555-ae3a-172c3cdd2e00", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-a1317ee8-1be3-4555-ae3a-172c3cdd2e00" } ], "id": "437ffe1f-ebba-4c1b-b328-ccbe8f6bccb9", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-437ffe1f-ebba-4c1b-b328-ccbe8f6bccb9" } ], "id": "71093058-df48-4f2e-837a-0f2121b2028f", "createdAt": "2026-07-28T01:27:24.000Z", "updatedAt": "2026-07-28T01:27:24.000Z", "uid": "35240-71093058-df48-4f2e-837a-0f2121b2028f" } ], "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" } ] }