Auto-Installation of Integration Records
Auto-installation adds an existing integration record to your NetSuite account automatically by a SOAP web services request. Your organization's users and admins can use auto-installation to add partners' integration records.
Auto-installation works with integration records that use user credentials, token-based auth, or OAuth 2.0 for authentication.
Whether using The Three-Step TBA Authorization Flow, calling The IssueToken Endpoint, or using OAuth 2.0, an Integration record is automatically installed in your account. The Require Approval preference controls whether the record is enabled automatically. You can manage this preference at Setup > Integration > Integration Management > SOAP Web Services Preferences. If the Require Approval box is unchecked (set to False), the application's State is set to Enabled, allowing all requests. If the box is checked (set to True), the integration record's State is set to Waiting for Approval. Then, you need to manually enable the record. Requests are blocked until you enable the record.
For more details about auto-installation, see the following sections:
When a record is auto-installed or bundled, its field values of many fields are set by the owning NetSuite account. These fields are read-only in the installed account. For details, see Ownership of Integration Records.
Understanding Auto-Installation
Note that any user with account access can trigger auto-installation, not only account administrators.
The most common use of auto-installation is when users download and run applications provided by partners. For instance, a partner might distribute a new app with a new integration record's application ID. Alternatively, a partner may have upgraded an existing application to use the 2015.2 or a later WSDL and include a new application ID.
You can also auto-install an integration record from your sandbox to production. If a record is removed during a sandbox refresh, you can restore it by auto-installation.
In all these cases, sending a request with the application ID automatically installs the integration record. However, the app's SOAP web services requests may or may not be automatically allowed. This behavior depends on a preference setting, as described in Configuring the Require-Approval Preference.
Configuring the Require-Approval Preference
The configuration of the Require Approval during Auto-Installation of Integration controls whether auto-installed integration records are enabled by default.
You can set this preference to one of two options:
-
False (default) – Newly installed records are enabled, and all requests are allowed.
-
True – Newly installed records are set to Waiting for Approval. Requests are blocked until you enable the record.
To review and approve each new integration manually, set this preference to True. If you're confident in granting access to new apps, set this preference to False.
You can manage this preference at Setup > Integration > SOAP Web Services Preferences.
For more details about using the State field, see Blocking SOAP Web Services Requests.