openapi: 3.0.1
info:
title: Coveo Activity Activities Organizations API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
tags:
- name: Organizations
paths:
/rest/organizations/{organizationId}:
get:
tags:
- Organizations
summary: Show Organization
description: Shows an [organization](https://docs.coveo.com/en/185/).
operationId: getOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: additionalFields
in: query
description: A line-separated list of additional fields to include.</br>**Example:** `license`</br>`status`
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationModel_Response'
x-pretty-name: getOrganization
x-ui-operation-id: /rest/organizations/paramId_get
put:
tags:
- Organizations
summary: Update Organization
description: Updates an [organization](https://docs.coveo.com/en/185/).
operationId: updateOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target organization to.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationModel_Request'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateOrganization
x-ui-operation-id: /rest/organizations/paramId_put
delete:
tags:
- Organizations
summary: Delete Organization
description: Delete an [organization](https://docs.coveo.com/en/185/).
externalDocs:
description: Delete an organization
url: https://docs.coveo.com/en/22/
operationId: deleteOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteOrganization
x-ui-operation-id: /rest/organizations/paramId_delete
/rest/organizations/{organizationId}/configuration/servingExperiment:
put:
tags:
- Organizations
summary: Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default.
operationId: setServingExperiment
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: allowed
in: query
description: Whether serving experiments are allowed
required: true
schema:
type: boolean
responses:
'204':
description: No Content
x-pretty-name: setServingExperiment
x-ui-operation-id: /rest/organizations/paramId/configuration/servingExperiment_put
/rest/organizations:
get:
tags:
- Organizations
summary: List Organizations
description: Lists all [organizations](https://docs.coveo.com/en/185/) you have access to.
operationId: getOrganizations
parameters:
- name: additionalFields
in: query
description: A line-separated list of additional fields to include.</br>**Example:** `license`</br>`status`
required: false
schema:
type: array
items:
type: string
- name: filter
in: 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.
required: false
schema:
type: string
- name: type
in: query
description: The type of organization to include in the returned list.</br>**Example:** `Test`</br>By default, organizations of all types may be included in the response.
required: false
schema:
type: string
- name: sortBy
in: query
description: The field to sort the returned organizations by.</br>**Example:** `createdDate`</br>**Default:** `displayName`
required: false
schema:
type: string
default: displayName
- name: order
in: query
description: 'The `sortBy` order to list the organizations in.</br>**Allowed values:**</br> - `ASC`: Ascending order.</br>- `DESC`: Descending order. </br>**Example:** `DESC`</br>**Default:** `ASC`'
required: false
schema:
type: string
default: asc
- name: page
in: query
description: The 0-based index number of the page to list.</br>**Example:** `5`</br>**Default:** `0`
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
description: The maximum number of organizations to list per page.</br>**Example:** `50`</br>**Default:** `100`
required: false
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelOrganizationModel_Response'
x-pretty-name: getOrganizations
x-ui-operation-id: /rest/organizations_get
post:
tags:
- Organizations
summary: Create Organization
description: Creates an [organization](https://docs.coveo.com/en/185/).
operationId: createOrganization
parameters:
- name: name
in: query
description: The name to assign to the new organization.
required: true
schema:
type: string
- name: owner
in: query
description: The email of the owner to assign to the new organization.
required: false
schema:
type: string
default: ''
- name: organizationTemplate
in: query
description: The name of the template to base the new organization on.
required: false
schema:
type: string
default: ''
example: TRIAL
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationCreatedModel'
x-pretty-name: createOrganization
x-ui-operation-id: /rest/organizations_post
/rest/organizations/{organizationId}/resume:
post:
tags:
- Organizations
summary: Resume Organization
description: Resumes a paused [organization](https://docs.coveo.com/en/185/).
externalDocs:
description: About inactive organizations
url: https://docs.coveo.com/en/2959#about-inactive-organizations
operationId: resumeOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ValueModelBoolean'
x-pretty-name: resumeOrganization
x-ui-operation-id: /rest/organizations/paramId/resume_post
/rest/organizations/{organizationId}/launchprovisioning:
post:
tags:
- Organizations
summary: Provision Organization
description: Launches the provisioning of an [organization](https://docs.coveo.com/en/185/).
operationId: launchProvisioning
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: launchProvisioning
x-ui-operation-id: /rest/organizations/paramId/launchprovisioning_post
/rest/organizations/{organizationId}/status:
get:
tags:
- Organizations
summary: Show Organization Status
description: Shows the status of an [organization](https://docs.coveo.com/en/185/).
externalDocs:
description: About Coveo system issue notifications
url: https://docs.coveo.com/en/1684/
operationId: getOrganizationStatus
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationStatusModel'
x-pretty-name: getOrganizationStatus
x-ui-operation-id: /rest/organizations/paramId/status_get
/rest/organizations/{organizationId}/authentication:
get:
tags:
- Organizations
summary: Lists All Authentication Providers for an Organization
operationId: listAuthentications
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OutgoingAuthentication'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/organizations/{organizationId}/authentication/saml:
get:
tags:
- Organizations
summary: Lists the SAML Authentications for an Organization
operationId: listSamlAuthentications
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OutgoingSamlAuthentication'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
post:
tags:
- Organizations
summary: Creates a New SAML Authentication in an Organization
operationId: createSamlAuthentication
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
requestBody:
description: The SAML authentication data
content:
application/json:
schema:
$ref: '#/components/schemas/IncomingSamlAuthentication'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedSamlAuthentication'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/organizations/{organizationId}/authentication/saml/{id}:
get:
tags:
- Organizations
summary: Loads a Single SAML Authentication from an Organization
operationId: loadSamlAuthentication
parameters:
- name: id
in: path
description: The SAML authentication ID
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OutgoingSamlAuthentication'
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
put:
tags:
- Organizations
summary: Updates a SAML Authentication in an Organization
operationId: updateSamlAuthentication
parameters:
- name: id
in: path
description: The SAML authentication ID
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdPath'
requestBody:
description: The SAML authentication data
content:
application/json:
schema:
$ref: '#/components/schemas/IncomingSamlAuthentication'
required: true
responses:
'200':
description: No response
content: {}
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
delete:
tags:
- Organizations
summary: Deletes a SAML Authentication from an Organization
operationId: deleteSamlAuthentication
parameters:
- name: id
in: path
description: The SAML authentication ID
required: true
schema:
type: string
- $ref: '#/components/parameters/OrganizationIdPath'
responses:
'200':
description: No response
content: {}
security:
- oauth2:
- full
description: '<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
/rest/organizations/{organizationId}/authentication/sharepoint:
get:
tags:
- Organizations
summary: List SharePoint Claims Authentication Providers
description: 'Gets all SharePoint claims authentication providers in a Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: listSharepointClaimsAuthProvider
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OutgoingSharePointAuthentication'
security:
- oauth2:
- full
post:
tags:
- Organizations
summary: Create SharePoint Claims Authentication Provider
description: 'Configures a new SharePoint claims authentication provider in a Coveo Cloud organization, allowing you to implement claims authentication in a search page (see [Claims Authentication](https://docs.coveo.com/en/113)).
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: createSharepointAuthenticationProvider
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
requestBody:
description: The SharePoint claims authentication provider information.
content:
application/json:
schema:
$ref: '#/components/schemas/IncomingSharePointAuthentication'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedSharePointAuthentication'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CreatedSharePointAuthentication'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/authentication/sharepoint/{id}:
get:
tags:
- Organizations
summary: Get SharePoint Claims Authentication Provider
description: 'Retrieves a single SharePoint claims authentication provider in a Coveo Cloud organization
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getSharepointAuthenticationProvider
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- name: id
in: path
description: The unique identifier of the target SharePoint claims authentication provider.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OutgoingSharePointAuthentication'
security:
- oauth2:
- full
put:
tags:
- Organizations
summary: Update SharePoint Claims Authentication Provider
description: 'Modifies an existing SharePoint claims authentication provider in a Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: updateSharepointAuthenticationProvider
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- name: id
in: path
description: The unique identifier of the target SharePoint claims authentication provider.
example: 120deecf-7822-4d7b-885f-53f184a3a76c
required: true
schema:
type: string
requestBody:
description: The updated SharePoint claims authentication provider information.
content:
application/json:
schema:
$ref: '#/components/schemas/IncomingSharePointAuthentication'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'204':
description: No content
content: {}
security:
- oauth2:
- full
delete:
tags:
- Organizations
summary: Delete SharePoint Claims Authentication Provider
description: 'Removes an existing SharePoint claims authentication provider from a Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: deleteSharepointAuthenticationProvider
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- name: id
in: path
description: The unique identifier of the target SharePoint claims authentication provider.
example: 120deecf-7822-4d7b-885f-53f184a3a76c
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'204':
description: No content
content: {}
security:
- oauth2:
- full
/rest/organizations/{organizationId}/authentication/trusteduris:
get:
tags:
- Organizations
summary: List Trusted Search Page URIs
description: 'Gets all existing trusted search page URI entries in a specific Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getTrustedUris
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListTrustedUriResponse'
security:
- oauth2:
- full
post:
tags:
- Organizations
summary: Add Trusted Search Page URI
description: "Creates a new trusted search page URI entry in a specific Coveo Cloud organization. Any search page whose URI begins with that prefix will be allowed to use the SAML SSO provider of that organization as a means of authentication. \n**Notes:** \n- No URI is trusted by default. \n- Creating a trusted search page URI entry with the empty string will result in **all** URIs being trusted, which is not recommended.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"AUTHENTICATION_EDITOR\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
operationId: addTrustedUri
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
requestBody:
description: The trusted search page URI information.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTrustedUriRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTrustedUriResponse'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/authentication/trusteduris/recentuntrusted:
get:
tags:
- Organizations
summary: List Recently Seen Search Page URIs That Were Not Trusted.
description: 'Lists URI that were recently seen during SSO but that were not trusted. The last 100 URI are kept for 7 days.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: getRecentUntrustedUris
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListRecentUntrustedUriResponse'
security:
- oauth2:
- full
/rest/organizations/{organizationId}/authentication/trusteduris/{id}:
delete:
tags:
- Organizations
summary: Delete Trusted Search Page URI
description: 'Removes a trusted search page URI entry from a specific Coveo Cloud organization.
<details>
<summary>Privilege(s) required</summary>
```json
{"level":"NORMAL","owner":"SEARCH_API","targetDomain":"AUTHENTICATION_EDITOR","type":"ENABLE","targetId":"*"}
```
</details>'
operationId: deleteTrustedUri
parameters:
- $ref: '#/components/parameters/OrganizationIdPath'
- name: id
in: path
description: The unique identifier of the trusted search page URI entry to delete.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'204':
description: No content
content: {}
security:
- oauth2:
- full
components:
schemas:
LicenseModel_Response:
type: object
properties:
accountId:
type: string
description: The unique identifier of the account that created the organization.
example: My Organization Account ID
accountName:
type: string
description: The name of the account.
example: My Organization Account
connectors:
type: array
description: A set of connectors that the license has access to.
items:
$ref: '#/components/schemas/ConnectorInformationModel_Response'
createdDate:
type: string
description: The creation date in number of milliseconds since UNIX epoch.
format: date-time
department:
type: string
description: The department the organization was created for.
example: R&D
entitlements:
type: array
description: A set of entitlements describing what the organization has access to.
items:
$ref: '#/components/schemas/EntitlementModel_Response'
expirationDate:
type: string
description: The date at which the license will expire (in number of milliseconds since UNIX epoch).
format: date-time
expirationStatus:
type: string
description: The expiration status indicating whether the license is active, about to expire, or expired.
enum:
- ACTIVE
- SOON_TO_BE_EXPIRED
- EXPIRED
indexBackupType:
type: string
description: The index backup type.
enum:
- NONE
- REGULAR
- FULL
indexType:
type: string
description: The type of index that is used for all sources in an organization
enum:
- COVEO
- ELASTIC
- INDEX_LESS
- ON_PREMISES
machineLearningModels:
type: object
additionalProperties:
$ref: '#/components/schemas/MachineLearningModelInformationModel_Response'
description: The Machine Learning Models configurations.
monitoringLevel:
type: string
description: The level of monitoring to apply to the license.
enum:
- NO_MONITORING
- BASIC_MONITORING
- REGULAR_MONITORING
- STRATEGIC_MONITORING
- CRITICAL_MONITORING
productEdition:
type: string
description: The edition in which the organization is registered as.
externalDocs:
description: Pricing plans
url: https://www.coveo.com/en/pricing
enum:
- ENTERPRISE
- FREE
- PRO
- STANDARD
- BASE
productName:
type: string
description: The product integration of which the organization has been registered.
enum:
- COVEO_CLOUD
- DYNAMICS
- SALESFORCE
- SERVICENOW
- SITECORE
- USAGE_ANALYTICS
productType:
type: string
description: The type of product integration in which the organization has been registered.
enum:
- INTERNAL
- SALES
- ALLIANCE
- SANDBOX
- STANDARD
- TRIAL
- TEST
properties:
type: object
additionalProperties:
type: object
description: Various properties/configuration settings that apply to the organization.
description: Various properties/configuration settings that apply to the organization.
description: The organization license.
IncomingSharePointAuthentication:
required:
- expiration
- name
- provider
- uri
type: object
properties:
name:
type: string
description: The name of this SharePoint claims authentication provider.
example: My SharePoint Claims Authentication Provider
uri:
type: string
description: 'The URI of the page that serves the claims information for this SharePoint server.
**Note:**
> This page is part of the Coveo SharePoint integration. You must install this package on your SharePoint server if you want to implement claims authentication in a search page (see [Installing the Coveo Web Service, Search Box, and Search Interface into SharePoint](http://www.coveo.com/go?dest=adminhelp70&lcid=9&context=4218)).'
example: https://hostname.com/_layouts/CES/SearchApiClaims.aspx
provider:
type: string
description: The name of the security identity provider which is associated to your SharePoint source in your Coveo Cloud organization.
example: My SharePoint Server Security Identity Provider
secret:
type: string
description: The string to use when signing claims information. This should be a random string. The longer the string, the safer.
example: k7dbdcu3HMTtdcRtZzx4uLvKB&T9kG8O12cQ2vOcaWiNmerw3RLQLpcCAnPL8wN
expiration:
type: integer
description: 'The amount of time (in milliseconds) the browser cookie that stores the claims information should last.
Setting this property to `0` expires the cookie when the browser session ends.
**Note:**
> When cookies aren''t supported by your browser, a JWT token will be used instead. For JWT tokens, the expiration
> must be between 15 minutes and 24 hours. Any value outside of these limits will be capped, with the exception of a 0 value
> which will be converted to the longest supported value (24 hours).'
format: int32
example: 86400000
enforceTrustedUris:
type: boolean
default: true
OrganizationCreatedModel:
type: object
properties:
id:
type: string
description: The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id).</br>**Example:** `mycoveocloudorganizationg8tp8wu3`
apiKey:
$ref: '#/components/schemas/ApiKeyModel'
description: Information pertaining to the newly created organization model.
OrganizationOwnerModel_Request:
type: object
properties:
email:
type: string
description: The email address of the organization owner.
description: The owner of the [organization](https://docs.coveo.com/en/185/).
IdAndDisp
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-organizations-api-openapi.yml