openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Credentials 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: Credentials description: '> Use these Connect API endpoints to get credentials for OAuth consumers of an external client app. Collections returns credentials for all consumers associated with an external client app. Resources returns the the key, secret, or both key and secret for a specific consumer.' paths: /data/v64.0/named-credentials/external-credentials: parameters: [] get: tags: - Credentials summary: Salesforce List External Credentials description: Get external credentials that the user can authenticate to. operationId: ListExternalCredentials parameters: [] responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 16:46:27 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 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/SuccessfulListExternalCredentials' - examples: - externalCredentials: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test contentMediaType: application/json;charset=UTF-8 example: externalCredentials: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test 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/named-credentials/named-credential-setup: parameters: [] get: tags: - Credentials summary: Salesforce List Named Credentials description: Get a list of named credentials in the org. operationId: ListNamedCredentials parameters: [] responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 16:45:55 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 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/SuccessfulListNamedCredentials' - examples: - namedCredentials: - calloutUrl: https://my.example.com developerName: Test id: 0XA... masterLabel: Test type: SecuredEndpoint url: /services/data/v58.0/named-credentials/named-credential-setup/Test contentMediaType: application/json;charset=UTF-8 example: namedCredentials: - calloutUrl: https://my.example.com developerName: Test id: 0XA... masterLabel: Test type: SecuredEndpoint url: /services/data/v58.0/named-credentials/named-credential-setup/Test 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/named-credentials/external-credentials/{DEVELOPER_NAME}: parameters: [] get: tags: - Credentials summary: Salesforce Get External Credentials by Developer Name description: Get an external credential, including the named credentials and principals associated with it and the type and status of each principal. operationId: GetExternalCredentialsbyDeveloperName parameters: - name: DEVELOPER_NAME in: path description: '' required: true schema: type: string example: example_value responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 20 Nov 2023 16:49:36 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 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/SuccessfulGetExternalCredentialsbyDeveloperName' - examples: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test contentMediaType: application/json;charset=UTF-8 example: authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test 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/tooling/query: parameters: [] get: tags: - Credentials summary: Salesforce List Named Credentials operationId: Listnamedcredentials parameters: - name: q in: query description: '' required: true style: form explode: true schema: type: string examples: - SELECT FIELDS(ALL) FROM NamedCredential LIMIT 200 example: example_value responses: '200': description: OK headers: Date: content: text/plain: schema: type: string contentMediaType: text/plain example: Mon, 03 Jul 2023 13:09:27 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-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 Sforce-Limit-Info: content: text/plain: schema: type: string contentMediaType: text/plain example: api-usage=5/15000 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/Listnamedcredentials' - examples: - size: 1 totalSize: 1 done: true queryLocator: null entityTypeName: NamedCredential records: - attributes: type: NamedCredential url: /services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO Id: 0XA4H000000TNRhWAO IsDeleted: false DeveloperName: Slack_Webhook_for_integration_Channel Language: en_US MasterLabel: 'Slack Webhook for #integration Channel' NamespacePrefix: null CreatedDate: 2020-11-06T14:04:44.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2020-11-06T14:04:44.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2020-11-06T14:04:44.000+0000 Endpoint: https://hooks.slack.com/services/SECRET PrincipalType: Anonymous JwtIssuer: null JwtFormulaSubject: null JwtTextSubject: null JwtValidityPeriodSeconds: null JwtAudience: null AuthTokenEndpointUrl: null contentMediaType: application/json;charset=UTF-8 example: size: 1 totalSize: 1 done: true queryLocator: null entityTypeName: NamedCredential records: - attributes: type: NamedCredential url: /services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO Id: 0XA4H000000TNRhWAO IsDeleted: false DeveloperName: Slack_Webhook_for_integration_Channel Language: en_US MasterLabel: 'Slack Webhook for #integration Channel' NamespacePrefix: null CreatedDate: 2020-11-06T14:04:44.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2020-11-06T14:04:44.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2020-11-06T14:04:44.000+0000 Endpoint: https://hooks.slack.com/services/SECRET PrincipalType: Anonymous JwtIssuer: null JwtFormulaSubject: null JwtTextSubject: null JwtValidityPeriodSeconds: null JwtAudience: null AuthTokenEndpointUrl: null deprecated: false servers: - url: https://services variables: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: SuccessfulListNamedCredentials: title: SuccessfulListNamedCredentials required: - namedCredentials type: object properties: namedCredentials: type: array items: $ref: '#/components/schemas/NamedCredential' description: '' example: [] examples: - namedCredentials: - calloutUrl: https://my.example.com developerName: Test id: 0XA... masterLabel: Test type: SecuredEndpoint url: /services/data/v58.0/named-credentials/named-credential-setup/Test SuccessfulGetExternalCredentialsbyDeveloperName: title: SuccessfulGetExternalCredentialsbyDeveloperName required: - authenticationProtocol - authenticationProtocolVariant - authenticationStatus - customHeaders - developerName - id - masterLabel - parameters - principals - relatedNamedCredentials - url type: object properties: authenticationProtocol: type: string example: example_value authenticationProtocolVariant: type: string example: example_value authenticationStatus: type: string example: example_value customHeaders: type: array items: type: string description: '' example: [] developerName: type: string example: example_value id: type: string example: abc123 masterLabel: type: string example: example_value parameters: type: array items: type: string description: '' example: [] principals: type: array items: type: string description: '' example: [] relatedNamedCredentials: type: array items: $ref: '#/components/schemas/RelatedNamedCredential' description: '' example: [] url: type: string example: https://www.example.com examples: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test Record11: title: Record11 required: - attributes - Id - IsDeleted - DeveloperName - Language - MasterLabel - NamespacePrefix - CreatedDate - CreatedById - LastModifiedDate - LastModifiedById - SystemModstamp - Endpoint - PrincipalType - JwtIssuer - JwtFormulaSubject - JwtTextSubject - JwtValidityPeriodSeconds - JwtAudience - AuthTokenEndpointUrl type: object properties: attributes: $ref: '#/components/schemas/Attributes4' Id: type: string example: abc123 IsDeleted: type: boolean example: true DeveloperName: type: string example: example_value Language: type: string example: example_value MasterLabel: type: string example: example_value NamespacePrefix: type: - string - 'null' example: example_value CreatedDate: type: string example: example_value CreatedById: type: string example: '500123' LastModifiedDate: type: string example: example_value LastModifiedById: type: string example: '500123' SystemModstamp: type: string example: example_value Endpoint: type: string example: example_value PrincipalType: type: string example: example_value JwtIssuer: type: - string - 'null' example: example_value JwtFormulaSubject: type: - string - 'null' example: example_value JwtTextSubject: type: - string - 'null' example: example_value JwtValidityPeriodSeconds: type: - string - 'null' example: example_value JwtAudience: type: - string - 'null' example: example_value AuthTokenEndpointUrl: type: - string - 'null' example: https://www.example.com examples: - attributes: type: NamedCredential url: /services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO Id: 0XA4H000000TNRhWAO IsDeleted: false DeveloperName: Slack_Webhook_for_integration_Channel Language: en_US MasterLabel: 'Slack Webhook for #integration Channel' NamespacePrefix: null CreatedDate: 2020-11-06T14:04:44.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2020-11-06T14:04:44.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2020-11-06T14:04:44.000+0000 Endpoint: https://hooks.slack.com/services/SECRET PrincipalType: Anonymous JwtIssuer: null JwtFormulaSubject: null JwtTextSubject: null JwtValidityPeriodSeconds: null JwtAudience: null AuthTokenEndpointUrl: null Listnamedcredentials: title: Listnamedcredentials required: - size - totalSize - done - queryLocator - entityTypeName - records type: object properties: size: type: integer contentEncoding: int32 example: 10 totalSize: type: integer contentEncoding: int32 example: 42 done: type: boolean example: true queryLocator: type: - string - 'null' example: example_value entityTypeName: type: string example: example_value records: type: array items: $ref: '#/components/schemas/Record11' description: '' example: [] examples: - size: 1 totalSize: 1 done: true queryLocator: null entityTypeName: NamedCredential records: - attributes: type: NamedCredential url: /services/data/v58.0/tooling/sobjects/NamedCredential/0XA4H000000TNRhWAO Id: 0XA4H000000TNRhWAO IsDeleted: false DeveloperName: Slack_Webhook_for_integration_Channel Language: en_US MasterLabel: 'Slack Webhook for #integration Channel' NamespacePrefix: null CreatedDate: 2020-11-06T14:04:44.000+0000 CreatedById: 00558000000yFyDAAU LastModifiedDate: 2020-11-06T14:04:44.000+0000 LastModifiedById: 00558000000yFyDAAU SystemModstamp: 2020-11-06T14:04:44.000+0000 Endpoint: https://hooks.slack.com/services/SECRET PrincipalType: Anonymous JwtIssuer: null JwtFormulaSubject: null JwtTextSubject: null JwtValidityPeriodSeconds: null JwtAudience: null AuthTokenEndpointUrl: null ExternalCredential: title: ExternalCredential required: - authenticationProtocol - authenticationProtocolVariant - authenticationStatus - customHeaders - developerName - id - masterLabel - parameters - principals - relatedNamedCredentials - url type: object properties: authenticationProtocol: type: string example: example_value authenticationProtocolVariant: type: string example: example_value authenticationStatus: type: string example: example_value customHeaders: type: array items: type: string description: '' example: [] developerName: type: string example: example_value id: type: string example: abc123 masterLabel: type: string example: example_value parameters: type: array items: type: string description: '' example: [] principals: type: array items: type: string description: '' example: [] relatedNamedCredentials: type: array items: $ref: '#/components/schemas/RelatedNamedCredential' description: '' example: [] url: type: string example: https://www.example.com examples: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test RelatedNamedCredential: title: RelatedNamedCredential required: - developerName - id - masterLabel - url type: object properties: developerName: type: string example: example_value id: type: string example: abc123 masterLabel: type: string example: example_value url: type: string example: https://www.example.com examples: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test NamedCredential: title: NamedCredential required: - calloutUrl - developerName - id - masterLabel - type - url type: object properties: calloutUrl: type: string example: https://www.example.com developerName: type: string example: example_value id: type: string example: abc123 masterLabel: type: string example: example_value type: type: string example: example_value url: type: string example: https://www.example.com examples: - calloutUrl: https://my.example.com developerName: Test id: 0XA... masterLabel: Test type: SecuredEndpoint url: /services/data/v58.0/named-credentials/named-credential-setup/Test SuccessfulListExternalCredentials: title: SuccessfulListExternalCredentials required: - externalCredentials type: object properties: externalCredentials: type: array items: $ref: '#/components/schemas/ExternalCredential' description: '' example: [] examples: - externalCredentials: - authenticationProtocol: Custom authenticationProtocolVariant: NoAuthentication authenticationStatus: NotConfigured customHeaders: [] developerName: Test id: 0pt... masterLabel: Test parameters: [] principals: [] relatedNamedCredentials: - developerName: Test id: 0XA... masterLabel: Test url: /services/data/v58.0/named-credentials/named-credential-setup/Test url: /services/data/v58.0/named-credentials/external-credentials/Test Attributes4: title: Attributes4 required: - type - url type: object properties: type: type: string example: example_value url: type: string example: https://www.example.com examples: - type: Account url: /services/data/v58.0/sobjects/Account/001... 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}". '