Salesforce Initialize API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Initialize 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: Initialize
paths:
  /services/auth/headless/init/registration:
    parameters: []
    post:
      tags:
      - Initialize
      summary: Salesforce Registration - Initialize
      description: 'Submits the registration data to the init/registration endpoint and returns a request identifier. At the same time, an OTP is sent out to the end users via email or sms. Registration data is passed in the request body, and is formatted with JSON, with 5 keys: `userdata`, `customdata`, `password`, `recaptcha`, and `verificationmethod`. The first two keys are JSON structures, and the last 3 keys are strings.


        This request returns JSON, and includes an identifier (request identifier).'
      operationId: Registration-Initialize
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Registration-InitializeRequest'
              - examples:
                - userdata:
                    firstName: userFirstName
                    lastName: userLastName
                    email: <email>
                    username: <username>
                  customdata:
                    mobilePhone: '+12035408967'
                    streetAddress: 12 N Lands End Rd
                    city: Lantana
                    state: Florida
                    zip: '20537'
                    privacyPolicy: true
                  password: Test123!
                  recaptcha: <recaptcha-token>
                  verificationmethod: email
              contentMediaType: application/json
            example:
              userdata:
                firstName: userFirstName
                lastName: userLastName
                email: <email>
                username: <username>
              customdata:
                mobilePhone: '+12035408967'
                streetAddress: 12 N Lands End Rd
                city: Lantana
                state: Florida
                zip: '20537'
                privacyPolicy: true
              password: Test123!
              recaptcha: <recaptcha-token>
              verificationmethod: email
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      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
  /services/auth/headless/forgot_password:
    parameters: []
    post:
      tags:
      - Initialize
      summary: Salesforce Forgot Password - Initialize
      operationId: ForgotPassword-Initialize
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ForgotPassword-InitializeRequest'
              - examples:
                - username: <username>
                  recaptcha: <recaptcha token>
              contentMediaType: application/json
            example:
              username: <username>
              recaptcha: <recaptcha token>
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      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
  /services/auth/headless/init/passwordless/login:
    parameters: []
    post:
      tags:
      - Initialize
      summary: Salesforce Passwordless Login - Initialize
      description: 'Submits the passwordless login data to the init/passwordless/login endpoint and returns a request identifier. At the same time, an OTP is sent out to the end users via email or sms. Passwordless login data is passed in the request body, and is formatted with JSON, with 3 keys: `username`, `recaptcha`, and `verificationmethod`. All 3 keys are strings.


        This request returns JSON, and includes an identifier (request identifier).'
      operationId: PasswordlessLogin-Initialize
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PasswordlessLogin-InitializeRequest'
              - examples:
                - username: <username>
                  recaptcha: <recaptcha-token>
                  verificationmethod: email or sms
              contentMediaType: application/json
            example:
              username: <username>
              recaptcha: <recaptcha-token>
              verificationmethod: email or sms
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      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
components:
  schemas:
    PasswordlessLogin-InitializeRequest:
      title: PasswordlessLogin-InitializeRequest
      required:
      - username
      - recaptcha
      - verificationmethod
      type: object
      properties:
        username:
          type: string
          example: example_value
        recaptcha:
          type: string
          example: example_value
        verificationmethod:
          type: string
          example: example_value
      examples:
      - username: <username>
        recaptcha: <recaptcha-token>
        verificationmethod: email or sms
    Customdata:
      title: Customdata
      required:
      - mobilePhone
      - streetAddress
      - city
      - state
      - zip
      - privacyPolicy
      type: object
      properties:
        mobilePhone:
          type: string
          example: example_value
        streetAddress:
          type: string
          example: example_value
        city:
          type: string
          example: example_value
        state:
          type: string
          example: example_value
        zip:
          type: string
          example: example_value
        privacyPolicy:
          type: boolean
          example: true
      examples:
      - mobilePhone: '+12035408967'
        streetAddress: 12 N Lands End Rd
        city: Lantana
        state: Florida
        zip: '20537'
        privacyPolicy: true
    ForgotPassword-InitializeRequest:
      title: ForgotPassword-InitializeRequest
      required:
      - username
      - recaptcha
      type: object
      properties:
        username:
          type: string
          example: example_value
        recaptcha:
          type: string
          example: example_value
      examples:
      - username: <username>
        recaptcha: <recaptcha token>
    Registration-InitializeRequest:
      title: Registration-InitializeRequest
      required:
      - userdata
      - customdata
      - password
      - recaptcha
      - verificationmethod
      type: object
      properties:
        userdata:
          $ref: '#/components/schemas/Userdata'
        customdata:
          $ref: '#/components/schemas/Customdata'
        password:
          type: string
          example: example_value
        recaptcha:
          type: string
          example: example_value
        verificationmethod:
          type: string
          example: example_value
      examples:
      - userdata:
          firstName: userFirstName
          lastName: userLastName
          email: <email>
          username: <username>
        customdata:
          mobilePhone: '+12035408967'
          streetAddress: 12 N Lands End Rd
          city: Lantana
          state: Florida
          zip: '20537'
          privacyPolicy: true
        password: Test123!
        recaptcha: <recaptcha-token>
        verificationmethod: email
    Userdata:
      title: Userdata
      required:
      - firstName
      - lastName
      - email
      - username
      type: object
      properties:
        firstName:
          type: string
          example: example_value
        lastName:
          type: string
          example: example_value
        email:
          type: string
          example: user@example.com
        username:
          type: string
          example: example_value
      examples:
      - firstName: userFirstName
        lastName: userLastName
        email: <email>
        username: <username>
  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}".

        '