openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Credential 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: Credential
paths:
  /data/v64.0/named-credentials/credential:
    parameters: []
    get:
      tags:
      - Credential
      summary: Salesforce Get Credential
      description: Get a credential.
      operationId: GetCredential
      parameters:
      - name: externalCredential
        in: query
        description: Fully qualified developer name of the external credential.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: principalName
        in: query
        description: Name of the external credential named principal.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      - name: principalType
        in: query
        description: 'Type of credential principal. Values are:

          * AwsStsPrincipal

          * NamedPrincipal

          * PerUserPrincipal'
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:01:04 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/SuccessfulGetCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationProtocolVariant: NoAuthentication
                    authenticationStatus: Configured
                    credentials: {}
                    externalCredential: Test
                    principalName: Test
                    principalType: NamedPrincipal
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationProtocolVariant: NoAuthentication
                authenticationStatus: Configured
                credentials: {}
                externalCredential: Test
                principalName: Test
                principalType: NamedPrincipal
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Credential
      summary: Salesforce Create Credential
      description: Create a credential.
      operationId: CreateCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateCredentialRequest'
              - examples:
                - authenticationProtocol: Custom
                  credentials: {}
                  externalCredential: SampleExternalCredential
                  principalName: SamplePrincipal
                  principalType: NamedPrincipal
              contentMediaType: application/json
            example:
              authenticationProtocol: Custom
              credentials: {}
              externalCredential: SampleExternalCredential
              principalName: SamplePrincipal
              principalType: NamedPrincipal
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 12:06:08 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/successfulCreateCredential'
                - examples:
                  - authenticationProtocol: Custom
                    authenticationStatus: Unknown
                    credentials: {}
                    externalCredential: SampleExternalCredential
                    principalName: SamplePrincipal
                    principalType: NamedPrincipal
                contentMediaType: application/json;charset=UTF-8
              example:
                authenticationProtocol: Custom
                authenticationStatus: Unknown
                credentials: {}
                externalCredential: SampleExternalCredential
                principalName: SamplePrincipal
                principalType: NamedPrincipal
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Credential
      summary: Salesforce Update Credential
      description: Update a credential.
      operationId: UpdateCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateCredentialRequest'
              - examples:
                - externalCredential: test
                  authenticationProtocol: Custom
                  principalName: test
                  principalType: NamedPrincipal
                  credentials:
                    testCredential:
                      value: '000000'
                      encrypted: true
              contentMediaType: application/json
            example:
              externalCredential: test
              authenticationProtocol: Custom
              principalName: test
              principalType: NamedPrincipal
              credentials:
                testCredential:
                  value: '000000'
                  encrypted: true
        required: true
      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
    delete:
      tags:
      - Credential
      summary: Salesforce Delete Credential
      description: Delete a credential.
      operationId: DeleteCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeleteCredentialRequest'
              - examples:
                - externalCredential: SampleExternalCredential
                  principalType: NamedPrincipal
                  principalName: SamplePrincipal
              contentMediaType: application/json
            example:
              externalCredential: SampleExternalCredential
              principalType: NamedPrincipal
              principalName: SamplePrincipal
        required: true
      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
  /data/v64.0/named-credentials/external-credentials:
    parameters: []
    post:
      tags:
      - Credential
      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/named-credential-setup:
    parameters: []
    post:
      tags:
      - Credential
      summary: Salesforce Create Named Credential
      description: Create a named credential.
      operationId: CreateNamedCredential
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateNamedCredentialRequest'
              - examples:
                - developerName: SamplePrivate
                  masterLabel: SamplePrivateLabel
                  type: SecuredEndpoint
                  calloutUrl: https://api.example.com
                  externalCredentials:
                  - developerName: SampleExternalCredential
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleValue
                    sequenceNumber: 1
                  calloutOptions:
                    allowMergeFieldsInBody: false
                    allowMergeFieldsInHeader: true
                    generateAuthorizationHeader: true
              contentMediaType: application/json
            example:
              developerName: SamplePrivate
              masterLabel: SamplePrivateLabel
              type: SecuredEndpoint
              calloutUrl: https://api.example.com
              externalCredentials:
              - developerName: SampleExternalCredential
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleValue
                sequenceNumber: 1
              calloutOptions:
                allowMergeFieldsInBody: false
                allowMergeFieldsInHeader: true
                generateAuthorizationHeader: true
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:54:12 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/SuccessfulCreateNamedCredential'
                - examples:
                  - calloutOptions:
                      allowMergeFieldsInBody: false
                      allowMergeFieldsInHeader: true
                      generateAuthorizationHeader: true
                    calloutUrl: https://api.example.com
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleValue
                      id: 0pv2o000000PAv6AAG
                      sequenceNumber: 1
                    developerName: SamplePrivate
                    externalCredentials:
                    - developerName: SampleExternalCredential
                      id: 0pt2o000000CaU0AAK
                      masterLabel: Sample External Credential
                      url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                    id: 0XA2o000000XaAQGA0
                    masterLabel: SamplePrivateLabel
                    parameters: []
                    type: SecuredEndpoint
                    url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                contentMediaType: application/json;charset=UTF-8
              example:
                calloutOptions:
                  allowMergeFieldsInBody: false
                  allowMergeFieldsInHeader: true
                  generateAuthorizationHeader: true
                calloutUrl: https://api.example.com
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleValue
                  id: 0pv2o000000PAv6AAG
                  sequenceNumber: 1
                developerName: SamplePrivate
                externalCredentials:
                - developerName: SampleExternalCredential
                  id: 0pt2o000000CaU0AAK
                  masterLabel: Sample External Credential
                  url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                id: 0XA2o000000XaAQGA0
                masterLabel: SamplePrivateLabel
                parameters: []
                type: SecuredEndpoint
                url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
      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: []
    put:
      tags:
      - Credential
      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:
      - Credential
      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/named-credentials/named-credential-setup/{DEVELOPER_NAME}:
    parameters: []
    get:
      tags:
      - Credential
      summary: Salesforce Get Named Credential by Developer Name
      description: Get a named credential.
      operationId: GetNamedCredentialbyDeveloperName
      parameters:
      - name: DEVELOPER_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:50:01 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/SuccessfulGetNamedCredentialbyDeveloperName'
                - examples:
                  - calloutOptions:
                      allowMergeFieldsInBody: false
                      allowMergeFieldsInHeader: false
                      generateAuthorizationHeader: true
                    calloutUrl: https://my.example.com
                    customHeaders: []
                    developerName: Test
                    externalCredentials:
                    - developerName: Test
                      id: 0pt...
                      masterLabel: Test
                      url: /services/data/v58.0/named-credentials/external-credentials/Test
                    id: 0XA...
                    masterLabel: Test
                    parameters: []
                    type: SecuredEndpoint
                    url: /services/data/v58.0/named-credentials/named-credential-setup/Test
                contentMediaType: application/json;charset=UTF-8
              example:
                calloutOptions:
                  allowMergeFieldsInBody: false
                  allowMergeFieldsInHeader: false
                  generateAuthorizationHeader: true
                calloutUrl: https://my.example.com
                customHeaders: []
                developerName: Test
                externalCredentials:
                - developerName: Test
                  id: 0pt...
                  masterLabel: Test
                  url: /services/data/v58.0/named-credentials/external-credentials/Test
                id: 0XA...
                masterLabel: Test
                parameters: []
                type: SecuredEndpoint
                url: /services/data/v58.0/named-credentials/named-credential-setup/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:
      - Credential
      summary: Salesforce Update Named Credential
      description: Update a named credential.
      operationId: UpdateNamedCredential
      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/UpdateNamedCredentialRequest'
              - examples:
                - masterLabel: SamplePrivateLabel
                  type: SecuredEndpoint
                  calloutUrl: https://api.example.com
                  externalCredentials:
                  - developerName: SampleExternalCredential
                  customHeaders:
                  - headerName: SampleHeader
                    headerValue: SampleValue
                    sequenceNumber: 1
                  calloutOptions:
                    allowMergeFieldsInBody: false
                    allowMergeFieldsInHeader: true
                    generateAuthorizationHeader: true
              contentMediaType: application/json
            example:
              masterLabel: SamplePrivateLabel
              type: SecuredEndpoint
              calloutUrl: https://api.example.com
              externalCredentials:
              - developerName: SampleExternalCredential
              customHeaders:
              - headerName: SampleHeader
                headerValue: SampleValue
                sequenceNumber: 1
              calloutOptions:
                allowMergeFieldsInBody: false
                allowMergeFieldsInHeader: true
                generateAuthorizationHeader: true
        required: true
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Mon, 20 Nov 2023 16:54:57 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/SuccessfulUpdateNamedCredential'
                - examples:
                  - calloutOptions:
                      allowMergeFieldsInBody: false
                      allowMergeFieldsInHeader: true
                      generateAuthorizationHeader: true
                    calloutUrl: https://api.example.com
                    customHeaders:
                    - headerName: SampleHeader
                      headerValue: SampleValue
                      id: 0pv2o000000PAv6AAG
                      sequenceNumber: 1
                    developerName: SamplePrivate
                    externalCredentials:
                    - developerName: SampleExternalCredential
                      id: 0pt2o000000CaU0AAK
                      masterLabel: Sample External Credential
                      url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                    id: 0XA2o000000XaAQGA0
                    masterLabel: SamplePrivateLabel
                    parameters: []
                    type: SecuredEndpoint
                    url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
                contentMediaType: application/json;charset=UTF-8
              example:
                calloutOptions:
                  allowMergeFieldsInBody: false
                  allowMergeFieldsInHeader: true
                  generateAuthorizationHeader: true
                calloutUrl: https://api.example.com
                customHeaders:
                - headerName: SampleHeader
                  headerValue: SampleValue
                  id: 0pv2o000000PAv6AAG
                  sequenceNumber: 1
                developerName: SamplePrivate
                externalCredentials:
                - developerName: SampleExternalCredential
                  id: 0pt2o000000CaU0AAK
                  masterLabel: Sample External Credential
                  url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
                id: 0XA2o000000XaAQGA0
                masterLabel: SamplePrivateLabel
                parameters: []
                type: SecuredEndpoint
                url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
      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/tooling/sobjects/NamedCredential/{NAMED_CREDENTIAL_ID}:
    parameters: []
    get:
      tags:
      - Credential
      summary: Salesforce Get Named Credential
      operationId: Getnamedcredential
      parameters:
      - name: NAMED_CREDENTIAL_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 0XA4H000000TNRhWAO
        example: '500123'
      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
    delete:
      tags:
      - Credential
      summary: Salesforce Delete Named Credential
      operationId: Deletenamedcredential
      parameters:
      - name: NAMED_CREDENTIAL_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: '500123'
      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
    patch:
      tags:
      - Credential
      summary: Salesforce Update Named Credential
      operationId: Updatenamedcredential
      parameters:
      - name: NAMED_CREDENTIAL_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 'null'
        example: '500123'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdatenamedcredentialRequest1'
              - examples:
                - FullName: MyNamedCredential
                  Metadata:
                    label: My Named Credential
                    endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
                    principalType: Anonymous
                    protocol: NoAuthentication
              contentMediaType: application/json
            example:
              FullName: MyNamedCredential
              Metadata:
                label: My Named Credential
                endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
                principalType: Anonymous
                protocol: NoAuthentication
        required: true
      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:
    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
    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
    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
    Credentials:
      title: Credentials
      required:
      - testCredential
      type: object
      properties:
        testCredential:
          $ref: '#/components/schemas/TestCredential'
      examples:
      - testCredential:
          value: '000000'
          encrypted: true
    SuccessfulCreateExternalCredential:
      title: SuccessfulCreateExternalCredential
      required:
      - authenticationProtocol
      - authenticationStatus
      - customHeaders
      - developerName
      - id
      - masterLabel
      - parameters
      - principals
      - relatedNamedCredentials
      - url
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        authenticationStatus:
          type: string
          example: example_value
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader1'
          description: ''
          example: []
        developerName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        principals:
          type: array
          items:
            $ref: '#/components/schemas/Principal1'
          description: ''
          example: []
        relatedNamedCredentials:
          type: array
          items:
            type: string
          description: ''
          example: []
        url:
          type: string
          example: https://www.example.com
      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
    UpdateNamedCredentialRequest:
      title: UpdateNamedCredentialRequest
      required:
      - masterLabel
      - type
      - calloutUrl
      - externalCredentials
      - customHeaders
      - calloutOptions
      type: object
      properties:
        masterLabel:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        calloutUrl:
          type: string
          example: https://www.example.com
        externalCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCredential2'
          description: ''
          example: []
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader'
          description: ''
          example: []
        calloutOptions:
          $ref: '#/components/schemas/CalloutOptions'
      examples:
      - masterLabel: SamplePrivateLabel
        type: SecuredEndpoint
        calloutUrl: https://api.example.com
        externalCredentials:
        - developerName: SampleExternalCredential
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleValue
          sequenceNumber: 1
        calloutOptions:
          allowMergeFieldsInBody: false
          allowMergeFieldsInHeader: true
          generateAuthorizationHeader: true
    DeleteCredentialRequest:
      title: DeleteCredentialRequest
      required:
      - externalCredential
      - principalType
      - principalName
      type: object
      properties:
        externalCredential:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
        principalName:
          type: string
          example: example_value
      examples:
      - externalCredential: SampleExternalCredential
        principalType: NamedPrincipal
        principalName: SamplePrincipal
    UpdatenamedcredentialRequest1:
      title: UpdatenamedcredentialRequest1
      required:
      - FullName
      - Metadata
      type: object
      properties:
        FullName:
          type: string
          example: example_value
        Metadata:
          $ref: '#/components/schemas/Metadata10'
      examples:
      - FullName: MyNamedCredential
        Metadata:
          label: My Named Credential
          endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
          principalType: Anonymous
          protocol: NoAuthentication
    CreateNamedCredentialRequest:
      title: CreateNamedCredentialRequest
      required:
      - developerName
      - masterLabel
      - type
      - calloutUrl
      - externalCredentials
      - customHeaders
      - calloutOptions
      type: object
      properties:
        developerName:
          type: string
          example: example_value
        masterLabel:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        calloutUrl:
          type: string
          example: https://www.example.com
        externalCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCredential2'
          description: ''
          example: []
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader'
          description: ''
          example: []
        calloutOptions:
          $ref: '#/components/schemas/CalloutOptions'
      examples:
      - developerName: SamplePrivate
        masterLabel: SamplePrivateLabel
        type: SecuredEndpoint
        calloutUrl: https://api.example.com
        externalCredentials:
        - developerName: SampleExternalCredential
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleValue
          sequenceNumber: 1
        calloutOptions:
          allowMergeFieldsInBody: false
          allowMergeFieldsInHeader: true
          generateAuthorizationHeader: true
    CreateCredentialRequest:
      title: CreateCredentialRequest
      required:
      - authenticationProtocol
      - credentials
      - externalCredential
      - principalName
      - principalType
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        credentials:
          type: object
          example: example_value
        externalCredential:
          type: string
          example: example_value
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
      examples:
      - authenticationProtocol: Custom
        credentials: {}
        externalCredential: SampleExternalCredential
        principalName: SamplePrincipal
        principalType: NamedPrincipal
    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
    Principal:
      title: Principal
      required:
      - principalName
      - principalType
      - sequenceNumber
      type: object
      properties:
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
        sequenceNumber:
          type: integer
          contentEncoding: int32
          example: 10
      examples:
      - principalName: SamplePrincipal
        principalType: NamedPrincipal
        sequenceNumber: 1
    RelatedNamedCredential:
      title: RelatedNamedCredential
      required:
      - developerName
      - id
      - masterLabel
      - url
      type: object
      properties:
        developerName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - developerName: Test
        id: 0XA...
        masterLabel: Test
        url: /services/data/v58.0/named-credentials/named-credential-setup/Test
    SuccessfulUpdateExternalCredential:
      title: SuccessfulUpdateExternalCredential
      required:
      - authenticationProtocol
      - authenticationStatus
      - customHeaders
      - developerName
      - id
      - masterLabel
      - parameters
      - principals
      - relatedNamedCredentials
      - url
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        authenticationStatus:
          type: string
          example: example_value
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader1'
          description: ''
          example: []
        developerName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        principals:
          type: array
          items:
            $ref: '#/components/schemas/Principal1'
          description: ''
          example: []
        relatedNamedCredentials:
          type: array
          items:
            $ref: '#/components/schemas/RelatedNamedCredential'
          description: ''
          example: []
        url:
          type: string
          example: https://www.example.com
      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
    ExternalCredential1:
      title: ExternalCredential1
      required:
      - developerName
      - id
      - masterLabel
      - url
      type: object
      properties:
        developerName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - developerName: Test
        id: 0pt...
        masterLabel: Test
        url: /services/data/v58.0/named-credentials/external-credentials/Test
    Metadata10:
      title: Metadata10
      required:
      - label
      - endpoint
      - principalType
      - protocol
      type: object
      properties:
        label:
          type: string
          example: Example Title
        endpoint:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
        protocol:
          type: string
          example: example_value
      examples:
      - label: My Named Credential
        endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
        principalType: Anonymous
        protocol: NoAuthentication
    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
    SuccessfulCreateNamedCredential:
      title: SuccessfulCreateNamedCredential
      required:
      - calloutOptions
      - calloutUrl
      - customHeaders
      - developerName
      - externalCredentials
      - id
      - masterLabel
      - parameters
      - type
      - url
      type: object
      properties:
        calloutOptions:
          $ref: '#/components/schemas/CalloutOptions'
        calloutUrl:
          type: string
          example: https://www.example.com
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader1'
          description: ''
          example: []
        developerName:
          type: string
          example: example_value
        externalCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCredential1'
          description: ''
          example: []
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - calloutOptions:
          allowMergeFieldsInBody: false
          allowMergeFieldsInHeader: true
          generateAuthorizationHeader: true
        calloutUrl: https://api.example.com
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleValue
          id: 0pv2o000000PAv6AAG
          sequenceNumber: 1
        developerName: SamplePrivate
        externalCredentials:
        - developerName: SampleExternalCredential
          id: 0pt2o000000CaU0AAK
          masterLabel: Sample External Credential
          url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
        id: 0XA2o000000XaAQGA0
        masterLabel: SamplePrivateLabel
        parameters: []
        type: SecuredEndpoint
        url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
    UpdateCredentialRequest:
      title: UpdateCredentialRequest
      required:
      - externalCredential
      - authenticationProtocol
      - principalName
      - principalType
      - credentials
      type: object
      properties:
        externalCredential:
          type: string
          example: example_value
        authenticationProtocol:
          type: string
          example: example_value
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
        credentials:
          $ref: '#/components/schemas/Credentials'
      examples:
      - externalCredential: test
        authenticationProtocol: Custom
        principalName: test
        principalType: NamedPrincipal
        credentials:
          testCredential:
            value: '000000'
            encrypted: true
    SuccessfulGetCredential:
      title: SuccessfulGetCredential
      required:
      - authenticationProtocol
      - authenticationProtocolVariant
      - authenticationStatus
      - credentials
      - externalCredential
      - principalName
      - principalType
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        authenticationProtocolVariant:
          type: string
          example: example_value
        authenticationStatus:
          type: string
          example: example_value
        credentials:
          type: object
          example: example_value
        externalCredential:
          type: string
          example: example_value
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
      examples:
      - authenticationProtocol: Custom
        authenticationProtocolVariant: NoAuthentication
        authenticationStatus: Configured
        credentials: {}
        externalCredential: Test
        principalName: Test
        principalType: NamedPrincipal
    ExternalCredential2:
      title: ExternalCredential2
      required:
      - developerName
      type: object
      properties:
        developerName:
          type: string
          example: example_value
      examples:
      - developerName: SampleExternalCredential
    SuccessfulGetNamedCredentialbyDeveloperName:
      title: SuccessfulGetNamedCredentialbyDeveloperName
      required:
      - calloutOptions
      - calloutUrl
      - customHeaders
      - developerName
      - externalCredentials
      - id
      - masterLabel
      - parameters
      - type
      - url
      type: object
      properties:
        calloutOptions:
          $ref: '#/components/schemas/CalloutOptions'
        calloutUrl:
          type: string
          example: https://www.example.com
        customHeaders:
          type: array
          items:
            type: string
          description: ''
          example: []
        developerName:
          type: string
          example: example_value
        externalCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCredential1'
          description: ''
          example: []
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - calloutOptions:
          allowMergeFieldsInBody: false
          allowMergeFieldsInHeader: false
          generateAuthorizationHeader: true
        calloutUrl: https://my.example.com
        customHeaders: []
        developerName: Test
        externalCredentials:
        - developerName: Test
          id: 0pt...
          masterLabel: Test
          url: /services/data/v58.0/named-credentials/external-credentials/Test
        id: 0XA...
        masterLabel: Test
        parameters: []
        type: SecuredEndpoint
        url: /services/data/v58.0/named-credentials/named-credential-setup/Test
    TestCredential:
      title: TestCredential
      required:
      - value
      - encrypted
      type: object
      properties:
        value:
          type: string
          example: example_value
        encrypted:
          type: boolean
          example: true
      examples:
      - value: '000000'
        encrypted: true
    successfulCreateCredential:
      title: successfulCreateCredential
      required:
      - authenticationProtocol
      - authenticationStatus
      - credentials
      - externalCredential
      - principalName
      - principalType
      type: object
      properties:
        authenticationProtocol:
          type: string
          example: example_value
        authenticationStatus:
          type: string
          example: example_value
        credentials:
          type: object
          example: example_value
        externalCredential:
          type: string
          example: example_value
        principalName:
          type: string
          example: example_value
        principalType:
          type: string
          example: example_value
      examples:
      - authenticationProtocol: Custom
        authenticationStatus: Unknown
        credentials: {}
        externalCredential: SampleExternalCredential
        principalName: SamplePrincipal
        principalType: NamedPrincipal
    SuccessfulUpdateNamedCredential:
      title: SuccessfulUpdateNamedCredential
      required:
      - calloutOptions
      - calloutUrl
      - customHeaders
      - developerName
      - externalCredentials
      - id
      - masterLabel
      - parameters
      - type
      - url
      type: object
      properties:
        calloutOptions:
          $ref: '#/components/schemas/CalloutOptions'
        calloutUrl:
          type: string
          example: https://www.example.com
        customHeaders:
          type: array
          items:
            $ref: '#/components/schemas/CustomHeader1'
          description: ''
          example: []
        developerName:
          type: string
          example: example_value
        externalCredentials:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCredential1'
          description: ''
          example: []
        id:
          type: string
          example: abc123
        masterLabel:
          type: string
          example: example_value
        parameters:
          type: array
          items:
            type: string
          description: ''
          example: []
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - calloutOptions:
          allowMergeFieldsInBody: false
          allowMergeFieldsInHeader: true
          generateAuthorizationHeader: true
        calloutUrl: https://api.example.com
        customHeaders:
        - headerName: SampleHeader
          headerValue: SampleValue
          id: 0pv2o000000PAv6AAG
          sequenceNumber: 1
        developerName: SamplePrivate
        externalCredentials:
        - developerName: SampleExternalCredential
          id: 0pt2o000000CaU0AAK
          masterLabel: Sample External Credential
          url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
        id: 0XA2o000000XaAQGA0
        masterLabel: SamplePrivateLabel
        parameters: []
        type: SecuredEndpoint
        url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
    CalloutOptions:
      title: CalloutOptions
      required:
      - allowMergeFieldsInBody
      - allowMergeFieldsInHeader
      - generateAuthorizationHeader
      type: object
      properties:
        allowMergeFieldsInBody:
          type: boolean
          example: true
        allowMergeFieldsInHeader:
          type: boolean
          example: true
        generateAuthorizationHeader:
          type: boolean
          example: true
      examples:
      - allowMergeFieldsInBody: false
        allowMergeFieldsInHeader: false
        generateAuthorizationHeader: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '