Salesforce Login API

The Login API from Salesforce — 1 operation(s) for login.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-login-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Login 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: Login
paths:
  /services/auth/headless/init/passwordless/login:
    parameters: []
    post:
      tags:
      - Login
      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
  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}".

        '