{ "info": { "_postman_id": "edfa6fb3-a5cb-4f84-9bcd-b60e654ae25c", "name": "Coveo Activity Activities Saml Identity Providers 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:31:31.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "lastUpdatedBy": "35240", "uid": "35240-edfa6fb3-a5cb-4f84-9bcd-b60e654ae25c" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "saml", "item": [ { "name": "identityprovider", "item": [ { "name": "realms", "item": [ { "name": "List Identity Provider Realms", "id": "febdc0c3-87ce-4aa6-bd46-a4f83a772a63", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider", "realms" ], "variable": [ { "id": "ef330d9b-4b1b-4c49-bdc9-2a5d9437da21", "key": "organizationId", "value": "", "description": "(Required) The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to list realms.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "description": "Lists the realms of a SAML identity provider.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "01d28b62-fb62-405d-aa46-3a373cfc611e", "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/saml/identityprovider/realms", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider", "realms" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"provider\": \"SAML\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n },\n {\n \"id\": \"\",\n \"provider\": \"EMAIL\",\n \"displayName\": \"\",\n \"samlIdentityProviderId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-01d28b62-fb62-405d-aa46-3a373cfc611e" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-febdc0c3-87ce-4aa6-bd46-a4f83a772a63" } ], "id": "a0b0ceda-15f2-49bb-a8c8-b19e23a8d18a", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-a0b0ceda-15f2-49bb-a8c8-b19e23a8d18a" }, { "name": "Show Identity Provider", "id": "f1a4787b-e6f5-4dd5-a7e1-653df9a6843f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "id": "286526b7-3f63-4017-b8d9-c5b13b2d3df0", "key": "organizationId", "value": "", "description": "(Required) The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to show the identity provider.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "description": "Shows the SAML identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "66748c01-e96e-418b-b475-a0d75b9ba0a1", "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/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-66748c01-e96e-418b-b475-a0d75b9ba0a1" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-f1a4787b-e6f5-4dd5-a7e1-653df9a6843f" }, { "name": "Update Identity Provider", "id": "fc3d8cba-db08-4651-8617-8af56bf6ef1f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "id": "ddcf2a64-5a5c-42fd-b100-27de17cc11b1", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Updates a SAML identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "ec629653-6f5e-4ad7-91be-12e09f2cb8b0", "name": "OK", "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 \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-ec629653-6f5e-4ad7-91be-12e09f2cb8b0" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-fc3d8cba-db08-4651-8617-8af56bf6ef1f" }, { "name": "Create Identity Provider", "id": "41349f93-1309-4d40-8c16-fd35161612da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "id": "faac19dc-874d-432a-b574-213b649d53c9", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates an identity provider for an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Create

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "396aa86b-550e-46ad-929a-e8eb9b817f25", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-396aa86b-550e-46ad-929a-e8eb9b817f25" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-41349f93-1309-4d40-8c16-fd35161612da" }, { "name": "Delete Identity Provider", "id": "ae80dc10-f05f-4e11-9319-32a1939c93f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "id": "f0242a4d-785e-490e-b740-62894aa1464b", "key": "organizationId", "value": "", "description": "(Required) The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to delete the SAML identity provider.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "description": "Deletes the identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "6c161057-fd2a-4674-996d-4e3169cfc064", "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/saml/identityprovider", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "identityprovider" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-6c161057-fd2a-4674-996d-4e3169cfc064" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-ae80dc10-f05f-4e11-9319-32a1939c93f1" } ], "id": "a6aca5df-98f7-4886-bcc6-3dfeac068f6e", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-a6aca5df-98f7-4886-bcc6-3dfeac068f6e" }, { "name": "enabled", "item": [ { "name": "Check If Any Identity Provider Exists", "id": "fcbf45c1-4bda-4265-a2bb-6580986eafb6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/enabled", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "enabled" ], "variable": [ { "id": "533ef1fa-742e-425d-aeb4-35aef722570d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Checks if any SAML identity provider exists in an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** Organization - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "a3fc0fd9-3668-4ff8-844f-c3dc2c679ae3", "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/saml/enabled", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "enabled" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"samlEnabled\": \"\",\n \"organizationId\": \"\"\n}", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-a3fc0fd9-3668-4ff8-844f-c3dc2c679ae3" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-fcbf45c1-4bda-4265-a2bb-6580986eafb6" } ], "id": "cf9957d0-f118-42ab-a4f5-9c8f66c7f0e1", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-cf9957d0-f118-42ab-a4f5-9c8f66c7f0e1" }, { "name": "availables", "item": [ { "name": "List Manageable Identity Providers", "id": "9b47d89d-e066-44b7-a4af-1ab7702b326c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/saml/availables", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "availables" ], "variable": [ { "id": "fdf51f52-f854-42e7-ac74-2137845fd9a0", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "List SAML identity providers that the current user can manage.
**Required privilege:** SAML identity provider - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "9d77ceb1-12c7-4e12-92e5-826d4e9a5f24", "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/saml/availables", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "saml", "availables" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"displayName\": \"\",\n \"entityId\": \"\",\n \"x509Certificate\": \"\",\n \"postBindingEndpoint\": \"\",\n \"organizationIds\": [\n {\n \"id\": \"\",\n \"displayName\": \"\"\n },\n {\n \"id\": \"\",\n \"displayName\": \"\"\n }\n ]\n }\n]", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-9d77ceb1-12c7-4e12-92e5-826d4e9a5f24" } ], "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-9b47d89d-e066-44b7-a4af-1ab7702b326c" } ], "id": "74ffa180-2fb5-4c61-b5ed-cce5bbef019b", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-74ffa180-2fb5-4c61-b5ed-cce5bbef019b" } ], "id": "02c22b72-407e-43c1-b4a5-68c484b797ef", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-02c22b72-407e-43c1-b4a5-68c484b797ef" } ], "id": "547390b4-24ef-4946-b791-b81aa034856d", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-547390b4-24ef-4946-b791-b81aa034856d" } ], "id": "bbf6b882-581d-49de-bcda-fcd21e30e203", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-bbf6b882-581d-49de-bcda-fcd21e30e203" } ], "id": "b57c808a-13ca-4029-ab3f-ca3f08082278", "createdAt": "2026-07-28T01:31:32.000Z", "updatedAt": "2026-07-28T01:31:32.000Z", "uid": "35240-b57c808a-13ca-4029-ab3f-ca3f08082278" } ], "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" } ] }