openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Authorize 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: Authorize paths: /services/oauth2/authorize: parameters: [] post: tags: - Authorize summary: Salesforce Registration - Authorize description: 'After you send your registration data to initialize, this request allows you to process that registration data, and as a part of this request you also verify the users email or sms number. The request itself is a authorization call for the Code and Credential flow. It includes 3 specific headers: `Auth-Request-Type` which is set to `user-registration`, `Auth-Verification-Type` which is set to email or sms, and an Authorization Basic header, which is the base 64 encoded result of `identifier:otp` where `identifier` is the value returned in your initialize registration call, and `otp` is the value sent to the end user via email or sms. The response from this API is the Auth Code, which is then exchanged for the Access Token.' operationId: Registration-Authorize parameters: - name: Auth-Request-Type in: header description: Required for User Registration required: true schema: type: string examples: - user-registration example: example_value - name: Auth-Verification-Type in: header description: Must match init/registration, email or sms required: true schema: type: string examples: - email example: example_value - name: Authorization in: header description: Base64 encoded required: true schema: type: string examples: - Basic example: example_value requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - response_type - client_id - redirect_uri - scope type: object properties: response_type: type: string examples: - code_credentials client_id: type: string examples: - '{{vault:salesforce-consumer-key}}' redirect_uri: type: string scope: type: string description: Comma seperated list of scopes, optional contentMediaType: application/x-www-form-urlencoded examples: RegistrationAuthorizeRequestExample: summary: Default Registration-Authorize request x-microcks-default: true value: response_type: example_value client_id: '500123' redirect_uri: example_value scope: example_value required: false 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: 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}". '