{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Organizations API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Show Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "additionalFields", "value": "", "type": "query", "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`" } ] }, "docs": "Shows an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Update Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Delete Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "Delete an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default.", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/configuration/servingExperiment", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "allowed", "value": "", "type": "query", "description": "Whether serving experiments are allowed" } ] }, "docs": "Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default." }, { "info": { "name": "List Organizations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations", "params": [ { "name": "additionalFields", "value": "", "type": "query", "description": "A line-separated list of additional fields to include.
**Example:** `license`
`status`" }, { "name": "filter", "value": "", "type": "query", "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." }, { "name": "type", "value": "", "type": "query", "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." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the returned organizations by.
**Example:** `createdDate`
**Default:** `displayName`" }, { "name": "order", "value": "", "type": "query", "description": "The `sortBy` order to list the organizations in.
**Allowed values:**
- `ASC`: Ascending order.
- `DESC`: Descending order.
**Example:** `DESC`
**Default:** `ASC`" }, { "name": "page", "value": "", "type": "query", "description": "The 0-based index number of the page to list.
**Example:** `5`
**Default:** `0`" }, { "name": "perPage", "value": "", "type": "query", "description": "The maximum number of organizations to list per page.
**Example:** `50`
**Default:** `100`" } ] }, "docs": "Lists all [organizations](https://docs.coveo.com/en/185/) you have access to." }, { "info": { "name": "Create Organization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations", "params": [ { "name": "name", "value": "", "type": "query", "description": "The name to assign to the new organization." }, { "name": "owner", "value": "", "type": "query", "description": "The email of the owner to assign to the new organization." }, { "name": "organizationTemplate", "value": "TRIAL", "type": "query", "description": "The name of the template to base the new organization on." } ] }, "docs": "Creates an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Resume Organization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/resume", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "Resumes a paused [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Provision Organization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/launchprovisioning", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "Launches the provisioning of an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Show Organization Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/status", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "Shows the status of an [organization](https://docs.coveo.com/en/185/)." }, { "info": { "name": "Lists All Authentication Providers for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Lists the SAML Authentications for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/saml", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Creates a New SAML Authentication in an Organization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/saml", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Loads a Single SAML Authentication from an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/saml/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The SAML authentication ID" }, { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Updates a SAML Authentication in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/saml/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The SAML authentication ID" }, { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Deletes a SAML Authentication from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/saml/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The SAML authentication ID" }, { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List SharePoint Claims Authentication Providers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/sharepoint", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Create SharePoint Claims Authentication Provider", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/sharepoint", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Get SharePoint Claims Authentication Provider", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/sharepoint/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the target SharePoint claims authentication provider." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Update SharePoint Claims Authentication Provider", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/sharepoint/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "id", "value": "120deecf-7822-4d7b-885f-53f184a3a76c", "type": "path", "description": "The unique identifier of the target SharePoint claims authentication provider." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Delete SharePoint Claims Authentication Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/sharepoint/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "id", "value": "120deecf-7822-4d7b-885f-53f184a3a76c", "type": "path", "description": "The unique identifier of the target SharePoint claims authentication provider." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "List Trusted Search Page URIs", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/trusteduris", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "page", "value": "", "type": "query", "description": "The 0-based number of the page of results to get." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of results to include per page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Add Trusted Search Page URI", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/trusteduris", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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\":\"" }, { "info": { "name": "List Recently Seen Search Page URIs That Were Not Trusted.", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/trusteduris/recentuntrusted", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "page", "value": "", "type": "query", "description": "The 0-based number of the page of results to get." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of results to include per page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" }, { "info": { "name": "Delete Trusted Search Page URI", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/authentication/trusteduris/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the trusted search page URI entry to delete." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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
" } ] } ], "bundled": true }