Salesforce Password API

The Password API from Salesforce — 3 operation(s) for password.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-password-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Password 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: Password
paths:
  /services/auth/headless/forgot_password:
    parameters: []
    post:
      tags:
      - Password
      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
  /data/v64.0/sobjects/User/{USER_ID}/password:
    parameters: []
    get:
      tags:
      - Password
      summary: Salesforce Sobject User Password
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: SObjectUserPassword
      parameters:
      - name: USER_ID
        in: path
        description: ''
        required: 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/sobjects/SelfServiceUser/{USER_ID}/password:
    parameters: []
    get:
      tags:
      - Password
      summary: Salesforce Sobject Self Service User Password
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: SObjectSelfServiceUserPassword
      parameters:
      - name: USER_ID
        in: path
        description: ''
        required: 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
components:
  schemas:
    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>
  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}".

        '