Specifies whether the connection should be made to a Salesforce sandbox environment rather than a production instance.

Data Type

bool

Default Value

false

Remarks

When UseSandbox is set to true, the provider connects to a Salesforce sandbox account, which is a testing and development environment separate from your production data. To authenticate correctly, you must also append the sandbox name to your username. For example, if your username is user and the sandbox name is sandbox, you should specify the User property as user.sandbox.

Salesforce sandbox environments are commonly used for development, staging, or testing without impacting production data. This property ensures that the connection is directed to the correct environment and endpoint. There are no direct performance impacts from setting this property, but sandbox environments may have different API limits or resource availability compared to production. Also, sandbox metadata and data may not be fully up-to-date with production unless a recent refresh has occurred. This property is useful for developers, testers, and administrators who need to safely test queries, operations, and integrations without affecting live production data.