Coveo Sources API

openapi: 3.0.1
info:
  title: Coveo Activity Activities Sources 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: Sources
paths:
  /rest/organizations/{organizationId}/schema/sources/SLACK/validateToken:
    post:
      operationId: validateSlackToken
      summary: Validates a Slack OAuth Token
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The OAuth token Guid linked with the token to validate.
        required: false
        in: query
        type: string
      - name: accessToken
        description: The OAuth token to validate.
        required: false
        in: query
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SlackTokenValidationStatus'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/defaultObjectsToGet:
    get:
      operationId: getDefaultObjectsToGet
      summary: Retrieves the Default Objects for a Source of Type Specified.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GenericObjectsToGet'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities:
    get:
      operationId: getSchemaEntities
      summary: Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The source's access token Guid (if authentified through access token)
        required: false
        in: query
        type: string
      - name: entityIds
        description: IDs of the entities to retrieve (comma-separated list)
        required: false
        in: query
        type: string
      - name: limit
        description: The number of entities to retrieve
        required: false
        in: query
        type: integer
        format: int32
      - name: offset
        description: Starting index of the first entity to retrieve
        required: false
        in: query
        type: integer
        format: int32
      - name: query
        description: A query used to match specific entities
        required: false
        in: query
        type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SchemaEntities'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}:
    get:
      operationId: getSchemaEntity
      summary: Retrieves the Entity Specified with Its Fields.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: filter
        description: The record count filter
        required: false
        in: query
        type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        type: string
      - name: entityId
        description: The id of the entity
        required: true
        in: path
        type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SchemaEntities'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}/fields:
    get:
      operationId: getSchemaEntityFields
      summary: Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        type: string
      - name: entityId
        description: The name of the entity
        required: true
        in: path
        type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SchemaEntities'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/generic:
    post:
      operationId: translateToGeneric
      summary: Computes the Generic Objects to Get from a Specific Objects to Get.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: specificOTG
        description: Specific objects to get
        required: true
        in: body
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GenericObjectsToGet'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specific:
    post:
      operationId: translateToSpecific
      summary: Computes the Specific Objects to Get from a Generic Objects to Get.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: genericOTG
        description: Generic objects to get
        required: true
        in: body
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SpecificObjectsToGet'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specificWithMappings:
    post:
      operationId: translateToSpecificWithMappings
      summary: Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The source's access token Guid (if authentified through access token)
        required: false
        in: query
        type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/JValue'
      security:
      - oauth2:
        - full
  /rest/organizations/{organizationId}/sources/{sourceId}:
    get:
      tags:
      - Sources
      summary: Get a Single Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: getSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_get
    put:
      tags:
      - Sources
      summary: Update a Source from Simple Configuration
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: updateSecurityProviders
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: rebuild
        in: query
        required: false
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/SourceModel'
              - $ref: '#/components/schemas/AmazonS3SourceModel'
              - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
              - $ref: '#/components/schemas/CatalogSourceModel'
              - $ref: '#/components/schemas/Confluence2HostedSourceModel'
              - $ref: '#/components/schemas/Confluence2SourceModel'
              - $ref: '#/components/schemas/CustomSourceModel'
              - $ref: '#/components/schemas/DatabaseSourceModel'
              - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
              - $ref: '#/components/schemas/FileSourceModel'
              - $ref: '#/components/schemas/GenericRestSourceModel'
              - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
              - $ref: '#/components/schemas/GraphQlSourceModel'
              - $ref: '#/components/schemas/Jira2HostedSourceModel'
              - $ref: '#/components/schemas/Jira2SourceModel'
              - $ref: '#/components/schemas/JiveHostedSourceModel'
              - $ref: '#/components/schemas/JiveSourceModel'
              - $ref: '#/components/schemas/KhorosSourceModel'
              - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
              - $ref: '#/components/schemas/PushSourceModel'
              - $ref: '#/components/schemas/RSSSourceModel'
              - $ref: '#/components/schemas/SAPSourceModel'
              - $ref: '#/components/schemas/SalesforceSitesSourceModel'
              - $ref: '#/components/schemas/SalesforceSourceModel'
              - $ref: '#/components/schemas/ServiceNowSourceModel'
              - $ref: '#/components/schemas/SharePointOnline2SourceModel'
              - $ref: '#/components/schemas/SharePointSourceModel'
              - $ref: '#/components/schemas/ShopifySourceModel'
              - $ref: '#/components/schemas/SitecoreSourceModel'
              - $ref: '#/components/schemas/SitemapSourceModel'
              - $ref: '#/components/schemas/SlackSourceModel'
              - $ref: '#/components/schemas/Web2SourceModel'
              - $ref: '#/components/schemas/YouTubeSourceModel'
              - $ref: '#/components/schemas/ZendeskSourceModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: updateSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_put
    delete:
      tags:
      - Sources
      summary: Delete a Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: deleteSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: deleteSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_delete
  /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}:
    get:
      tags:
      - Sources
      summary: Get a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduleModel'
      x-pretty-name: getSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_get
    put:
      tags:
      - Sources
      summary: Update a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleModel'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduleModel'
      x-pretty-name: updateSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_put
    delete:
      tags:
      - Sources
      summary: Delete a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: deleteSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      x-pretty-name: deleteSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_delete
  /rest/organizations/{organizationId}/sources/{sourceId}/raw:
    get:
      tags:
      - Sources
      summary: Get the Raw Configuration of a Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getRawSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: includeMappings
        in: query
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RawSourceConfig'
      x-pretty-name: getRawSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/raw_get
    put:
      tags:
      - Sources
      summary: Update a Source from Raw Configuration
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateRawSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: updateSecurityProviders
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: rebuild
        in: query
        required: false
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RawSourceConfig'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNow

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