openapi: 3.1.0 info: title: Salesforce Bulk API 2.0 Abort Oauth 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: Oauth paths: /services/data/v64.0/apps/oauth/usage: parameters: [] get: tags: - Oauth summary: Salesforce Oauth Usage description: Lists all the external client apps for the current org. See [OAuth Usage](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage.htm). operationId: OAuthUsage parameters: - name: page in: query description: Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. required: true style: form explode: true schema: type: integer contentEncoding: int32 examples: - 0 example: 10 - name: pageSize in: query description: Number of usage entries per page. Defaults to 100. required: true style: form explode: true schema: type: integer contentEncoding: int32 examples: - 100 example: 10 - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value responses: default: description: '' headers: {} content: text/plain: schema: type: string examples: - "{\n \"apps\": [\n {\n \"accessTokenFormat\": \"\",\n \"availableActions\": \"disable, enable\",\n \"description\": \"\",\n \"developerName\": \"\",\n \"identifier\": \"\",\n \"isFromPackage\": bool,\n \"usageDetailsUrl\": \"/services/data//apps/oauth/usage//users\"\n }\n ],\n \"currentPageUrl\": \"/services/data//apps/oauth/usage?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data//apps/oauth/usage?page=1&pageSize=100\"\n}" contentMediaType: text/plain example: "{\n \"apps\": [\n {\n \"accessTokenFormat\": \"\",\n \"availableActions\": \"disable, enable\",\n \"description\": \"\",\n \"developerName\": \"\",\n \"identifier\": \"\",\n \"isFromPackage\": bool,\n \"usageDetailsUrl\": \"/services/data//apps/oauth/usage//users\"\n }\n ],\n \"currentPageUrl\": \"/services/data//apps/oauth/usage?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data//apps/oauth/usage?page=1&pageSize=100\"\n}" 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/data/v64.0/apps/oauth/usage//users: parameters: [] get: tags: - Oauth summary: Salesforce Oauth App Users description: Lists all users for the external client app indicated by the app ID. See [OAuth Users by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_users.htm). operationId: OAuthAppUsers parameters: - name: page in: query description: Page number for the usage information. Defaults to 0. required: true style: form explode: true schema: type: integer contentEncoding: int32 examples: - 0 example: 10 - name: pageSize in: query description: Number of usage entries per page. Defaults to 100. required: true style: form explode: true schema: type: integer contentEncoding: int32 examples: - 100 example: 10 - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value responses: default: description: '' headers: {} content: text/plain: schema: type: string examples: - "{\n \"currentPageUrl\": \"/services/data//apps/oauth/usage//users?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data//apps/oauth/usage//users?page=1&pageSize=100\",\n \"users\": [\n {\n \"accessTokenFormat\": \"\",\n \"appDeveloperName\": \"\",\n \"appIdentifier\": \"\",\n \"initialConnectionAt\": \"\",\n \"lastUsedAt\": \"\",\n \"revocationUrl\": \"/services/data//apps/oauth/usage///tokens\",\n \"useCount\": integer,\n \"userIdentifier\": \"\",\n \"username\": \"\"\n }\n ]\n}" contentMediaType: text/plain example: "{\n \"currentPageUrl\": \"/services/data//apps/oauth/usage//users?page=0&pageSize=100\",\n \"nextPageUrl\": \"/services/data//apps/oauth/usage//users?page=1&pageSize=100\",\n \"users\": [\n {\n \"accessTokenFormat\": \"\",\n \"appDeveloperName\": \"\",\n \"appIdentifier\": \"\",\n \"initialConnectionAt\": \"\",\n \"lastUsedAt\": \"\",\n \"revocationUrl\": \"/services/data//apps/oauth/usage///tokens\",\n \"useCount\": integer,\n \"userIdentifier\": \"\",\n \"username\": \"\"\n }\n ]\n}" 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/data/v64.0/apps/oauth/usage///tokens: parameters: [] get: tags: - Oauth summary: Salesforce Oauth App Users Tokens description: Lists all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm). operationId: OAuthAppUsersTokens parameters: - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value responses: default: description: '' headers: {} content: text/plain: schema: type: string examples: - "{\n \"currentPageUrl\": \"/services/data//apps/oauth/usage///tokens\",\n \"tokens\": [\n {\n \"accessTokenFormat\": \"\",\n \"appDeveloperName\": \"\",\n \"appIdentifier\": \"\",\n \"initialConnectionAt\": \"\",\n \"lastUsedAt\": \"\",\n \"revocationUrl\": \"/services/data//apps/oauth/usage/tokens/\",\n \"useCount\": integer,\n \"userIdentifier\": \"\",\n \"username\": \"\"\n }\n ]\n}" contentMediaType: text/plain example: "{\n \"currentPageUrl\": \"/services/data//apps/oauth/usage///tokens\",\n \"tokens\": [\n {\n \"accessTokenFormat\": \"\",\n \"appDeveloperName\": \"\",\n \"appIdentifier\": \"\",\n \"initialConnectionAt\": \"\",\n \"lastUsedAt\": \"\",\n \"revocationUrl\": \"/services/data//apps/oauth/usage/tokens/\",\n \"useCount\": integer,\n \"userIdentifier\": \"\",\n \"username\": \"\"\n }\n ]\n}" 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 delete: tags: - Oauth summary: Salesforce Oauth User Tokens Revoke description: Revokes all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm). operationId: OAuthUserTokensRevoke parameters: - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value 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/data/v64.0/apps/oauth/usage//tokens: parameters: [] delete: tags: - Oauth summary: Salesforce Oauth Tokens Revoke description: Revokes all tokens available for the external client app. See [Refresh Token by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_tokens.htm). operationId: OAuthTokensRevoke parameters: - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value 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/data/v64.0/apps/oauth/usage/tokens/: parameters: [] delete: tags: - Oauth summary: Salesforce Oauth Token Revoke description: Revokes one token. See [OAuth Refresh Token](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_tokens_token_id.htm). operationId: OAuthTokenRevoke parameters: - name: Authorization in: header description: Replace with your access token required: true schema: type: string examples: - Bearer example: example_value 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}". '