Coveo Organizations API

openapi: 3.2.0
info:
  title: Coveo Organizations API
  version: 1.0.0
  x-refined-note:
  - x-ApiVersion differs across the merged source definitions and was not carried
  description: 'Operations tagged Organizations across 3 of this provider''s published API definitions: coveo-organization-openapi-original.yml, coveo-platform-openapi-original.yml, coveo-search-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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>'
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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>'
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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>'
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
components:
  schemas:
    ValueModelBoolean:
      type: object
      properties:
        value:
          type: boolean
    EntitlementModel_Response:
      type: object
      properties:
        id:
          type: string
        productId:
          type: string
        pricingUnit:
          type: string
        displayName:
          type: string
        productName:
          type: string
        useCase:
          type: string
        status:
          type: string
        itemLimit:
          type: integer
          format: int64
        semanticSearchDocumentLimit:
          type: integer
          format: int64
        semanticSearchQPMLimit:
          type: integer
          format: int64
        lrpmLimit:
          type: integer
          format: int64
        qpmLimit:
          type: integer
          format: int64
        unlimitedQPM:
          type: boolean
        recommendationLimit:
          type: integer
          format: int64
        unlimitedRecommendations:
          type: boolean
        userLimit:
          type: integer
          format: int64
        unlimitedUsers:
          type: boolean
        passageRetrievalQPMLimit:
          type: integer
          format: int64
        unlimitedPassageRetrievalQPM:
          type: boolean
        shouldShowInConsumptionDashboard:
          type: boolean
        expirationDate:
          type: string
          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
      description: A set of entitlements describing what the organization has access to.
    LightProvisioningStatusModel_Response:
      type: object
      properties:
        currentProvisioningProgress:
          type: number
          description: The progress, in percentage, of the ongoing provisioning.</br>**Example:** `100`
          format: float
        initialProvisioningDone:
          type: boolean
          description: Whether the initial provisioning has been completed.
        lastProvisioningCompletedDate:
          type: string
          description: The last time provisioning was successfully completed in number of milliseconds since UNIX epoch.</br>**Example:** `1556722921779`
          format: date-time
        ongoing:
          type: boolean
          description: Whether the provisioning is currently ongoing.
        status:
          type: string
          description: 'The status of the last provisioning.</br>**Allowed values:**</br>- `ERROR`: The last provisioning failed with an error.</br>- `HEALTHY`: The last provisioning finished successfully.'
          enum:
          - ERROR
          - HEALTHY
      description: The provisioning status of the [organization](https://docs.coveo.com/en/185/).</br>See [Understanding Organization Provisioning](https://docs.coveo.com/en/2547/).
    OrganizationOwnerModel_Response:
      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/).
    ApiKeyAdditionalConfigurationModel:
      type: object
      properties:
        commerce:
          $ref: '#/components/schemas/CommerceApiKeyConfigurationModel'
        search:
          $ref: '#/components/schemas/SearchApiKeyConfigurationModel'
        analytics:
          $ref: '#/components/schemas/AnalyticsConfigurationModel'
      description: The additional configuration to attach to the API key.
    IdAndDisplayNameModel:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
    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

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-organizations-api-openapi.yml