Salesforce External API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort External API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: External
paths:
  /data/v64.0/named-credentials/external-credentials:
    parameters: []
    get:
      tags:
      - External
      summary: Salesforce List External Credentials
      description: Get external credentials that the user can authenticate to.
      operationId: ListExternalCredentials
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:46:27 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulListExternalCredentials'
                - examples:
                  - externalCredentials:
                    - authenticationProtocol: Custom
                      authenticationProtocolVariant: NoAuthentication
                      authenticationStatus: NotConfigured
                      customHeaders: []
                      developerName: Test
                      id: 0pt...
                      masterLabel: Test
                      parameters: []
                      principals: []
                      relatedNamedCredentials:
                      - developerName: Test
                        id: 0XA...
                        masterLabel: Test
                        url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                      url: /services/data/v58.0/named-credentials/external-credentials/Test
                contentMediaType: application/json;charset=UTF-8
              example:
                externalCredentials:
                - authenticationProtocol: Custom
                  authenticationProtocolVariant: NoAuthentication
                  authenticationStatus: NotConfigured
                  customHeaders: []
                  developerName: Test
                  id: 0pt...
                  masterLabel: Test
                  parameters: []
                  principals: []
                  relatedNamedCredentials:
                  - developerName: Test
                    id: 0XA...
                    masterLabel: Test
                    url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                  url: /services/data/v58.0/named-credentials/external-credentials/Test
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - External
      summary: Salesforce Create External Credential
      description: Create an external credential.
      operationId: CreateExternalCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateExternalCredentialRequest'
              - examples:
                - developerName: SampleExternalCredential
                  masterLabel: Sample External Credential
                  authenticationProtocol: Custom
                  principals:
                  - principalName: SamplePrincipal
                    principalType: NamedPrincipal
                    sequenceNumber: 1
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleHeaderValue
                    sequenceNumber: 1
              contentMediaType: application/json
            example:
              developerName: SampleExternalCredential
              masterLabel: Sample External Credential
              authenticationProtocol: Custom
              principals:
              - principalName: SamplePrincipal
                principalType: NamedPrincipal
                sequenceNumber: 1
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleHeaderValue
                sequenceNumber: 1
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:53:51 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulCreateExternalCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleHeaderValue
                      id: 0pu2o000000KymkAAC
                      sequenceNumber: 1
                    developerName: SampleExternalCredential
                    id: 0pt2o000000CaU0AAK
                    masterLabel: Sample External Credential
                    parameters: []
                    principals:
                    - authenticationStatus: Unknown
                      id: 0pu2o000000KymjAAC
                      parameters: []
                      principalAccess: []
                      principalName: SamplePrincipal
                      principalType: NamedPrincipal
                      sequenceNumber: 1
                    relatedNamedCredentials: []
                    url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleHeaderValue
                  id: 0pu2o000000KymkAAC
                  sequenceNumber: 1
                developerName: SampleExternalCredential
                id: 0pt2o000000CaU0AAK
                masterLabel: Sample External Credential
                parameters: []
                principals:
                - authenticationStatus: Unknown
                  id: 0pu2o000000KymjAAC
                  parameters: []
                  principalAccess: []
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
                  sequenceNumber: 1
                relatedNamedCredentials: []
                url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/named-credentials/external-credentials/{DEVELOPER_NAME}:
    parameters: []
    get:
      tags:
      - External
      summary: Salesforce Get External Credentials by Developer Name
      description: Get an external credential, including the named credentials and principals associated with it and the type and status of each principal.
      operationId: GetExternalCredentialsbyDeveloperName
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:49:36 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulGetExternalCredentialsbyDeveloperName'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationProtocolVariant: NoAuthentication
                    authenticationStatus: NotConfigured
                    customHeaders: []
                    developerName: Test
                    id: 0pt...
                    masterLabel: Test
                    parameters: []
                    principals: []
                    relatedNamedCredentials:
                    - developerName: Test
                      id: 0XA...
                      masterLabel: Test
                      url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                    url: /services/data/v58.0/named-credentials/external-credentials/Test
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationProtocolVariant: NoAuthentication
                authenticationStatus: NotConfigured
                customHeaders: []
                developerName: Test
                id: 0pt...
                masterLabel: Test
                parameters: []
                principals: []
                relatedNamedCredentials:
                - developerName: Test
                  id: 0XA...
                  masterLabel: Test
                  url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                url: /services/data/v58.0/named-credentials/external-credentials/Test
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - External
      summary: Salesforce Update External Credential
      description: Update an external credential.
      operationId: UpdateExternalCredential
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateExternalCredentialRequest'
              - examples:
                - masterLabel: Sample External Credential
                  authenticationProtocol: Custom
                  principals:
                  - principalName: SamplePrincipal
                    principalType: NamedPrincipal
                    sequenceNumber: 1
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleHeaderValue
                    sequenceNumber: 1
              contentMediaType: application/json
            example:
              masterLabel: Sample External Credential
              authenticationProtocol: Custom
              principals:
              - principalName: SamplePrincipal
                principalType: NamedPrincipal
                sequenceNumber: 1
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleHeaderValue
                sequenceNumber: 1
        required: true
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:55:19 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulUpdateExternalCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleHeaderValue
                      id: 0pu2o000000KymkAAC
                      sequenceNumber: 1
                    developerName: SampleExternalCredential
                    id: 0pt2o000000CaU0AAK
                    masterLabel: Sample External Credential
                    parameters: []
                    principals:
                    - authenticationStatus: Unknown
                      id: 0pu2o000000KymjAAC
                      parameters: []
                      principalAccess: []
                      principalName: SamplePrincipal
                      principalType: NamedPrincipal
                      sequenceNumber: 1
                    relatedNamedCredentials:
                    - developerName: SamplePrivate
                      id: 0XA2o000000XaAQGA0
                      masterLabel: SamplePrivateLabel
                      url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                    url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleHeaderValue
                  id: 0pu2o000000KymkAAC
                  sequenceNumber: 1
                developerName: SampleExternalCredential
                id: 0pt2o000000CaU0AAK
                masterLabel: Sample External Credential
                parameters: []
                principals:
                - authenticationStatus: Unknown
                  id: 0pu2o000000KymjAAC
                  parameters: []
                  principalAccess: []
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
                  sequenceNumber: 1
                relatedNamedCredentials:
                - developerName: SamplePrivate
                  id: 0XA2o000000XaAQGA0
                  masterLabel: SamplePrivateLabel
                  url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - External
      summary: Salesforce Delete External Credential
      description: Delete an external credential.
      operationId: DeleteExternalCredential
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      responses:
        '204':
          description: No Content
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:09:23 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            Content-Security-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: upgrade-insecure-requests
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
          content: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/{SOBJECT_API_NAME}/{FIELD_NAME}/{FIELD_VALUE}:
    parameters: []
    get:
      tags:
      - External
      summary: Salesforce Sobject Rows by External Id
      description: 'Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.


        If the specified value doesn''t exist, a new record is created.

        If a record does exist with that value, the field values specified in the request body are updated.

        If the value is not unique, the REST API returns a 300 response with the list of matching records.


        HEAD, GET, PATCH, DELETE, POST'
      operationId: SObjectRowsbyExternalID
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_VALUE
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CustomHeader:
      title: CustomHeader
      required:
      - headerName
      - headerValue
      - sequenceNumber
      type: object
      properties:
        headerName:
          type: string
          example: example_value
        headerValue:
          type: string
          example: example_value
        sequenceNumber:
          type: integer
          contentEncoding: int32
          example: 10
      examples:
      - headerName: SampleHeader
        headerValue: SampleHeaderValue
        sequenceNumber: 1
    CreateExternalCredentialRequest:
      title: CreateExternalCredentialRequest
      required:
      - developerName
      - masterLabel
      - authenticationProtocol
      - principals
      - customHeaders
      type: object
      properties:
        developerName:
          type: string
          example: example_value
        masterLabel:
          type: string
          example: example_value
        authenticationProtocol:
          type: string
          example: example_value
        principals:
          type: array
          items:
            $ref: '#/components/schemas/Principal'
          description: ''
          example: []
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader'
          description: ''
          example: []
      examples:
      - developerName: SampleExternalCredential
        masterLabel: Sample External Credential
        authenticationProtocol: Custom
        principals:
        - principalName: SamplePrincipal
          principalType: NamedPrincipal
          sequenceNumber: 1
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleHeaderValue
          sequenceNumber: 1
    UpdateExternalCredentialRequest:
      title: UpdateExternalCredentialRequest
      required:
      - masterLabel
      - authenticationProtocol
      - principals
      - customHeaders
      type: object
      properties:
        masterLabel:
          type: string
          example: example_value
        authenticationProtocol:
          type: string
          example: example_value
        principals:
          type: array
          items:
            $ref: '#/components/schemas/Principal'
          description: ''
          example: []
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader'
          description: ''
          example: []
      examples:
      - masterLabel: Sample External Credential
        authenticationProtocol: Custom
        principals:
        - principalName: SamplePrincipal
          principalType: NamedPrincipal
          sequenceNumber: 1
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleHeaderValue
          sequenceNumber: 1
    Principal1:
      title: Principal1
      required:
      - authenticationStatus
      - id
      - parameters
      - principalAccess
      - principalName
      - principalType
      - sequenceNumber
      type: object
      properties:
        authenticationStatus:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        principalAccess:
          type: array
          items:
            type: string
          description: ''
          example: []
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
        sequenceNumber:
          type: integer
          contentEncoding: int32
          example: 10
      examples:
      - authenticationStatus: Unknown
        id: 0pu2o000000KymjAAC
        parameters: []
        principalAccess: []
        principalName: SamplePrincipal
        principalType: NamedPrincipal
        sequenceNumber: 1
    CustomHeader1:
      title: CustomHeader1
      required:
      - headerName
      - headerValue
      - id
      - sequenceNumber
      type: object
      properties:
        headerName:
          type: string
          example: example_value
        headerValue:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        sequenceNumber:
          type: integer
          contentEncoding: int32
          example: 10
      examples:
      - headerName: SampleHeader
        headerValue: SampleHeaderValue
        id: 0pu2o000000KymkAAC
        sequenceNumber: 1
    SuccessfulGetExternalCredentialsbyDeveloperName:
      title: SuccessfulGetExternalCredentialsbyDeveloperName
      required:
      - authenticationProtocol
      - authenticationProtocolVariant
      - authenticationStatus
      - customHeaders
      - developerName
      - id
      - masterLabel
      - parameters
      - principals
      - relatedNamedCredentials
      - url
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        authenticationProtocolVariant:
          type: string
          example: example_value
        authenticationStatus:
          type: string
          example: example_value
        customHeaders:
          type: array
          items:
            type: string
          description: ''
          example: []
        developerName:
          type: string

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