Salesforce Configuration API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Configuration 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: Configuration
paths:
  /.well-known/auth-configuration:
    parameters: []
    get:
      tags:
      - Configuration
      summary: Salesforce Authentication Configuration Endpoint
      operationId: AuthenticationConfigurationEndpoint
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Thu, 16 Nov 2023 15:54:15 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
            Access-Control-Allow-Credentials:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 'false'
            Access-Control-Allow-Methods:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: GET, POST, OPTIONS
            Access-Control-Allow-Origin:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '*'
            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/SuccessfulAuthenticationConfigurationEndpoint'
                - examples:
                  - OrgId: 00D2o000000i6mB
                    Url: https://<my_domain>
                    MobileSDK:
                      UseiOSNativeBrowserForAuthentication: false
                      UseAndroidNativeBrowserForAuthentication: false
                      shareBrowserSessionIOS: false
                      shareBrowserSessionAndroid: false
                    LoginPage: null
                    SamlProviders: []
                    AuthProviders: []
                    CertificateLogin: null
                    LoginPageType: standard
                    LoginPageTypeConfigs: {}
                contentMediaType: application/json;charset=UTF-8
              example:
                OrgId: 00D2o000000i6mB
                Url: https://<my_domain>
                MobileSDK:
                  UseiOSNativeBrowserForAuthentication: false
                  UseAndroidNativeBrowserForAuthentication: false
                  shareBrowserSessionIOS: false
                  shareBrowserSessionAndroid: false
                LoginPage: null
                SamlProviders: []
                AuthProviders: []
                CertificateLogin: null
                LoginPageType: standard
                LoginPageTypeConfigs: {}
      deprecated: false
      security: []
      servers:
      - url: https://login.salesforce.com
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /apexrest/SBQQ/ServiceRouter:
    parameters: []
    patch:
      tags:
      - Configuration
      summary: Salesforce Configuration Loader Api
      description: 'The Configuration Loader API returns all the data for the product, including its product options and configuration model. When configuring a nested bundle, set the parentProductproperty to the parent product to inherit configuration attributes on the nested bundle.

        Available in: Salesforce CPQ Spring ’17 and later


        https://developer.salesforce.com/docs/atlas.en-us.cpq_dev_api.meta/cpq_dev_api/cpq_api_config_loader.htm'
      operationId: ConfigurationLoaderAPI
      parameters:
      - name: loader
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - SBQQ.ConfigAPI.ConfigLoader
        example: example_value
      - name: uid
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: '500123'
      - 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
  /data/v64.0/support/embeddedservice/configuration/{EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME}:
    parameters: []
    get:
      tags:
      - Configuration
      summary: Salesforce Embedded Service Configuration Describe
      description: 'Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.


        You must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.'
      operationId: EmbeddedServiceConfigurationDescribe
      parameters:
      - name: EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME
        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:
    MobileSDK:
      title: MobileSDK
      required:
      - UseiOSNativeBrowserForAuthentication
      - UseAndroidNativeBrowserForAuthentication
      - shareBrowserSessionIOS
      - shareBrowserSessionAndroid
      type: object
      properties:
        UseiOSNativeBrowserForAuthentication:
          type: boolean
          example: true
        UseAndroidNativeBrowserForAuthentication:
          type: boolean
          example: true
        shareBrowserSessionIOS:
          type: boolean
          example: true
        shareBrowserSessionAndroid:
          type: boolean
          example: '500123'
      examples:
      - UseiOSNativeBrowserForAuthentication: false
        UseAndroidNativeBrowserForAuthentication: false
        shareBrowserSessionIOS: false
        shareBrowserSessionAndroid: false
    SuccessfulAuthenticationConfigurationEndpoint:
      title: SuccessfulAuthenticationConfigurationEndpoint
      required:
      - OrgId
      - Url
      - MobileSDK
      - LoginPage
      - SamlProviders
      - AuthProviders
      - CertificateLogin
      - LoginPageType
      - LoginPageTypeConfigs
      type: object
      properties:
        OrgId:
          type: string
          example: '500123'
        Url:
          type: string
          example: https://www.example.com
        MobileSDK:
          $ref: '#/components/schemas/MobileSDK'
        LoginPage:
          type:
          - string
          - 'null'
          example: example_value
        SamlProviders:
          type: array
          items:
            type: string
          description: ''
          example: []
        AuthProviders:
          type: array
          items:
            type: string
          description: ''
          example: []
        CertificateLogin:
          type:
          - string
          - 'null'
          example: example_value
        LoginPageType:
          type: string
          example: example_value
        LoginPageTypeConfigs:
          type: object
          example: example_value
      examples:
      - OrgId: 00D2o000000i6mB
        Url: https://<my_domain>
        MobileSDK:
          UseiOSNativeBrowserForAuthentication: false
          UseAndroidNativeBrowserForAuthentication: false
          shareBrowserSessionIOS: false
          shareBrowserSessionAndroid: false
        LoginPage: null
        SamlProviders: []
        AuthProviders: []
        CertificateLogin: null
        LoginPageType: standard
        LoginPageTypeConfigs: {}
  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}".

        '