---
schema_version: "1"
id: ea1054997ad4792c8d3427473152ca73fab8915061c8ebcc4860dba98feb68c5
title: Salesforce Composite Connector 3.1 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/salesforce-composite-connector/latest/salesforce-composite-connector-reference.md
canonical_url: https://docs.mulesoft.com/salesforce-composite-connector/latest/salesforce-composite-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 06a49fb9dec933f980cbfffc50a35bd45520b254b7cf66235a8b7ea585e60b00
description: MuleSoft Documentation Site
release: "3.1"
latest: true
---
---
product: Salesforce Composite Connector
version: 3.1
is-latest-version: true
---

# Salesforce Composite Connector 3.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Configurations

---

### Default Configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#composite-config_config-with-oauth">OAuth v2.0</a></p></li><li><p><a href="#composite-config_oauth-client-credentials">OAuth Client Credentials</a></p></li><li><p><a href="#composite-config_oauth-jwt">OAuth JWT</a></p></li><li><p><a href="#composite-config_oauth-saml">OAuth SAML</a></p></li><li><p><a href="#composite-config_oauth-user-pass">OAuth Username Password</a></p></li><li><p><a href="#composite-config_token-connection">Token Connection</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Connection Types

### OAuth v2.0

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to <code>0</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Response Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The socket connection timeout value. This attribute works in tandem with Connection Timeout Time Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the Connection Timeout.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth consumerKey as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth consumerSecret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Authorization Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s authorization endpoint URL. The default is <code>https://login.salesforce.com/services/oauth2/authorize</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Access Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s accessToken endpoint URL. The default is <code>https://login.salesforce.com/services/oauth2/token</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth scopes to request during the dance. If not provided, it defaults to the scopes provided in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Resource Owner Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The resource owner ID that each component uses if it is not otherwise referenced.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Before</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a flow to execute immediately before starting the OAuth dance.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>After</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of a flow to execute immediately after an accessToken is received.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A reference to a <code>&lt;http:listener-config /&gt;</code> to use to create the listener that receives the access token callback endpoint.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path of the access token callback endpoint.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>External Callback Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>If the callback endpoint is behind a proxy or accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A reference to the object store to use to store each resource owner ID’s data. If an object store is not specified, Mule automatically provisions the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth Client Credentials

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to <code>0</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Response Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The socket connection timeout value. This attribute works in tandem with Connection Timeout Time Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the Connection Timeout.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Client Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth client ID as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Client Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth client secret as registered with the service provider.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Token Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The service provider’s token endpoint URL. The default is <code>https://login.salesforce.com/services/oauth2/token</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Scopes</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The OAuth scopes to request during the dance. If not provided, it defaults to the scopes provided in the annotation.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A reference to the object store to use to store each resource owner ID’s data. If an object store is not specified, Mule automatically provisions the default object store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth JWT

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

> [!NOTE] When configuring a Salesforce external client app for OAuth JWT authentication, disable
> **Issue JSON Web Token (JWT)-based access tokens for named users** so that Salesforce returns an
> opaque access token instead of a JWT-formatted access token.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to <code>0</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Response Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The socket connection timeout value. This attribute works in tandem with Connection Timeout Time Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the Connection Timeout.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Consumer key for the Salesforce-connected app.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the key store used to sign data during authentication.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password of the key store.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Certificate Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the certificate.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username of the Salesforce user on whose behalf to take action.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Token Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL pointing to the server responsible for providing the authentication token. The default is <code>https://login.salesforce.com/services/oauth2/token</code>.</p></div><div><p>If implementation is for a community, <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your community URL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Audience Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The audience identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token.</p></div><div><p>Use the authorization server’s URL for the audience value: <code>https://login.salesforce.com</code>. For testing, use: <code>https://test.salesforce.com</code>. For a community implementation, use: <code>https://community.force.com/customers</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth SAML

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time until a response is received. This attribute works in tandem with Response Timeout Unit. Values less than one millisecond are converted to <code>0</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Response Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The socket connection timeout value. This attribute works in tandem with Connection Timeout Time Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the Connection Timeout.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Consumer key for the Salesforce-connected app.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the key store used to sign data during authentication.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Store Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password of the key store.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Certificate Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the certificate.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username of the Salesforce user on whose behalf to take action.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Token Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL pointing to the server responsible for providing the authentication token. The default is <code>https://login.salesforce.com/services/oauth2/token</code>.</p></div><div><p>If implementation is for a community, <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your community URL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### OAuth Username Password

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div><div><p>HTTP</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If the Host is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Wait time until a response is received. This attribute works in tandem with Time Unit. Values less than one millisecond are converted to <code>0</code>.</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Response Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The socket connection timeout value. This attribute works in tandem with Connection Timeout Time Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the Connection Timeout.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Consumer key for Salesforce-connected app.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Your application’s client secret (consumer secret in Remote Access Detail).</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to initialize the session.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate the user</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Security Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>User’s security token. It can be omitted if your IP has been allowlisted on Salesforce.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Token Endpoint</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL pointing to the server responsible for providing the authentication token. The default is <code>https://login.salesforce.com/services/oauth2/token</code>.</p></div><div><p>If implementation is for a community, <code>https://acme.force.com/customers/services/oauth2/token</code>, where <code>acme.force.com/customers</code> is your community URL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Token Connection

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Session Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Session ID.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Instance Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Instance URL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>TLS configuration</strong></p></td><td><div><div><p><a href="#tls-configuration">TLS Configuration</a></p></div></div></td><td><div><div><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the key store in the <code>tls:context</code> child element of the <code>listener-config</code>.</p></div></div></td><td><div><div><p><code>HTTP</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hostname of the proxy. Required if a proxy is used. If this property is not set, then no proxy is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port of the proxy. If <strong>Host</strong> is set, then this property is required and the value cannot be a negative number.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Username used to authenticate against the proxy. If this property is not set, then no authentication is used against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long Mule waits for a response to complete before the request times out.</p></div></div></td><td><div><div><p><code>5</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Response timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Response timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Socket connection timeout value.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection Timeout Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Connection Timeout</strong> field.</p></div></div></td><td><div><div><p><code>SECONDS</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max connections</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of outbound connections to keep open at the same time. Use <code>-1</code> for unlimited.</p></div></div></td><td><div><div><p>-1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Use persistent connections</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If set to <code>false</code>, each connection is closed after the first request completes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How long a connection can remain idle before it is closed. Only applies when persistent connections are enabled. This attribute works in tandem with Connection Idle Timeout Unit.</p></div></div></td><td><div><div><p>30</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Connection idle timeout unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit to use for the Connection Idle Timeout parameter.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Operations

- [Create Sobject Collections](#createSobjectCollections)

- [Create sObject Tree](#createSobjectTree)

- [Delete sObject Collections](#deleteSobjectCollections)

- [Execute Composite Batch](#executeCompositeBatch)

- [Execute Composite Graph](#executeCompositeGraph)

- [Execute Composite Request](#executeCompositeRequest)

- [Get sObject Collections](#getSobjectCollections)

- [Post Create](#postCreate)

- [Post Delete](#postDelete)

- [Post Get Limits](#postGetLimits)

- [Post Query](#postQuery)

- [Post Query All](#postQueryAll)

- [Post Retrieve](#postRetrieve)

- [Post Search](#postSearch)

- [Post Update](#postUpdate)

- [Pre Create](#preCreate)

- [Pre Delete](#preDelete)

- [Pre Get Limits](#preGetLimits)

- [Pre Query](#preQuery)

- [Pre Query All](#preQueryAll)

- [Pre Retrieve](#preRetrieve)

- [Pre Search](#preSearch)

- [Pre Update](#preUpdate)

- [Unauthorize](#unauthorize)

- [Update sObject Collections](#updateSobjectCollections)

- [Upsert sObject Collections](#upsertSobjectCollections)

### Create Sobject Collections

`<salesforce-composite:create-sobject-collections>`

Add up to 200 records and return a list of `SaveResult` objects. You can roll back the entire
request if an error occurs.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Body</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The request body.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Create sObject Tree

`<salesforce-composite:create-sobject-tree>`

Sends a list of sObject trees to Salesforce to be created.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>SObject Root Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The sObject type of the root of the trees.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>SObject Tree</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>A list of maps containing representing the list of trees that need to be created.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Delete sObject Collections

`<salesforce-composite:delete-sobject-collections>`

Delete up to 200 records and return a list of `DeleteResult` objects. You can roll back the entire
request if an error occurs.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Ids</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>The IDs of the entities to be deleted.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>All Or None</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates whether to roll back the entire request when the deletion of any object fails.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Execute Composite Batch

`<salesforce-composite:execute-composite-batch>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Sub Requests</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>The list of subrequests to execute.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Execute Composite Graph

`<salesforce-composite:execute-composite-graph>`

Performs composite requests by executing a series of REST API requests in a single call.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Graphs</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>List of graphs to execute</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:VALIDATION

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:INVALID\_SESSION

### Execute Composite Request

`<salesforce-composite:execute-composite-request>`

Execute a series of REST API requests in a single call. You can use the output of one request as the
input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in
a single response body. The entire request counts as a single call toward your API limits.

> [!NOTE] You can add `httpHeaders` within `compositeRequest`, for example:
> `"httpHeaders" : { "X-REQUEST-ID" : "ReferenceId" }`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Body</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Request body</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Get sObject Collections

`<salesforce-composite:get-sobject-collections>`

Retrieve one or more records of the same object type.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The sObject type of the root of the trees.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>List of ids</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>A list of one or more IDs of the objects to return. All IDs must belong to the same object type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>List of fields</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>A list of fields to include in the response.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Create

`<salesforce-composite:post-create>`

Provide metadata for the result of a create. This operation takes as input one record from the
result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a create
subrequest generated by `preCreate(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Create Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the create subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Delete

`<salesforce-composite:post-delete>`

Provide metadata for the result of a delete. This operation takes as input one record from the
result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a delete
subrequest generated by `preDelete(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Delete Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the delete subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Get Limits

`<salesforce-composite:post-get-limits>`

Provide metadata for the result of a get limits request. This operation takes as input one record
from the result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a get
limits subrequest generated by `preGetLimits()`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Get Limits Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the create subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Query

`<salesforce-composite:post-query>`

Provide metadata for the result of a query. This operation takes as input one record from the result
returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a query subrequest
generated by `preQuery(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The query that was used in the <code>preQuery</code> operation - needed for metadata.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the query subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Query All

`<salesforce-composite:post-query-all>`

Provide metadata for the result of a query. This operation takes as input one record from the result
returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a query subrequest
generated by `preQueryAll(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the create subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Retrieve

`<salesforce-composite:post-retrieve>`

Provide metadata for the result of a retrieve. This operation takes as input one record from the
result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a retrieve
subrequest generated by `preRetrieve(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of the retrieved object - used for metadata.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Retrieve Data</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the retrieve subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Search

`<salesforce-composite:post-search>`

Provide metadata for the result of a search. This operation takes as input one record from the
result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to a search
subrequest generated by `preSearch(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Search Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the search subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Post Update

`<salesforce-composite:post-update>`

Provide metadata for the result of an update. This operation takes as input one record from the
result returned by `executeCompositeBatch(String, java.util.List)`, which belongs to an update
subrequest generated by `preUpdate(String, java.util.Map)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Update Result</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The result of the update subrequest.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Create

`<salesforce-composite:pre-create>`

Provide metadata for a create based on an object that is created and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object to create.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>S Object</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Object to create as a map that sticks to metadata for a selected type.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Delete

`<salesforce-composite:pre-delete>`

Provide metadata for a delete based on an object that is deleted and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object that is deleted.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the object that is deleted.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Get Limits

`<salesforce-composite:pre-get-limits>`

Provide metadata for getLimits and generate a subrequest for execution by
`executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Query

`<salesforce-composite:pre-query>`

Provides metadata for a query based on an object that is queried, and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The query that is run in <code>executeCompositeBatch</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The parameters to use in a parameterized query.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Query All

`<salesforce-composite:pre-query-all>`

Provide metadata for a query based on an object that is queried and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Query</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The query that is run in <code>executeCompositeBatch</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The parameters to use in a parameterized query.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Retrieve

`<salesforce-composite:pre-retrieve>`

Provide metadata for a retrieve based on an object that is retrieved and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Retrieve Data</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Object to retrieve as a map that sticks to metadata for a selected type.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Search

`<salesforce-composite:pre-search>`

Provide the user a way to input a SOSL String and generate a subrequest for execution by
`executeCompositeBatch(java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Search</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The SOSL string that is run in executeCompositeBatch.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Pre Update

`<salesforce-composite:pre-update>`

Provide metadata for a create based on an object that is created and generates a subrequest for
execution by `executeCompositeBatch(String, java.util.List)`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of object that is created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>SObject</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Object to create as a map that sticks to metadata for a selected type.</p></div></div></td><td><div><div><p><code>#[payload]</code>.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Unauthorize

`<salesforce-composite:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it’s impossible to
execute any operation for that user without repeating the authorization dance.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p><strong>x</strong></p></div></div></td></tr><tr><td><p><strong>Resource Owner Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The ID of the resource owner for whom to invalidate access</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

### Update sObject Collections

`<salesforce-composite:update-sobject-collections>`

Update up to 200 records and return a list of `SaveResult` objects. You can roll back the entire
request if an error occurs.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Body</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The request body.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

### Upsert sObject Collections

`<salesforce-composite:upsert-sobject-collections>`

Upsert up to 200 records of same type and return a list of `SaveResult` objects. You can roll back
the entire request if an error occurs.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The sObject type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>External Field Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the external field for this sobject type.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Request Body</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>The request body.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Config Ref</strong></p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><div><div><p>Name of the configuration to use to execute this component.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable in which to store the operation’s output</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></div></div></td><td><div><div><p><code>#[payload]</code></p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#error-mapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type a</p></td><td><p>Array of Object</p></td></tr><tr><td><p>Attributes Type a</p></td><td><p>Object</p></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#composite-config)

#### Throws

- SALESFORCE-COMPOSITE:CONNECTIVITY

- SALESFORCE-COMPOSITE:INVALID\_SESSION

- SALESFORCE-COMPOSITE:RETRY\_EXHAUSTED

- SALESFORCE-COMPOSITE:TRANSACTION

- SALESFORCE-COMPOSITE:TRANSFORMATION

- SALESFORCE-COMPOSITE:UNKNOWN

- SALESFORCE-COMPOSITE:VALIDATION

## Types

### TLS Configuration

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma separated list that defines the enabled TLS protocols, which must be a subset of the globally enabled TLS protocols.</p></div></div></td><td><div><div><p>By default, the globally enabled TLS protocols are used.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Chiper Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma separated list that defines the enabled TLS cipher suites, which must be a subset of the globally enabled cipher suites.</p></div></div></td><td><div><div><p>By default, the globally enabled cipher suites are used.</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store Configuration</strong></p></td><td><div><div><p><a href="#trust-store-configuration">Trust Store Configuration</a></p></div></div></td><td><div><div><p>Contains the configuration parameters for the trust store configuration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store Configuration</strong></p></td><td><div><div><p><a href="#key-store-configuration">Key Store Configuration</a></p></div></div></td><td><div><div><p>Contains the configuration parameters for the key store configuration</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store Configuration

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the location of the trust store to use, which will be resolved relative to the current classpath and file system, if possible. A password is also required.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to access the trust store that is specified in the path.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store Configuration

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a
public certificate.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the location of the key store to use, which will be resolved relative to the current classpath and file system, if possible.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the alias of the key to use when the key store contains many private keys. By default, the first key in the file is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the password to access the key store that is specified in the path.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines the algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Verify only the last element in the certificate chain.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Verify all elements in the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer CRLs</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Use the method that wasn’t specified in the <strong>Prefer CRLs</strong> field (the secondary method) to check certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Do not use the secondary method to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Avoid verification failure.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Allow the verification to fail.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>URL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response, if present. The certificate must be in the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

Specifies the location of the certification revocation list (CRL) file.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to reconnect (in milliseconds).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to
reconnect at a specified frequency for as long as the Mule app runs.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of instances that is initially allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the <strong>Buffer Size Increment</strong> attribute, with an upper limit of <code>maxInMemorySize</code>. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, then it will start to buffer the content on disk.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)