Setting Up Token-Based Authentication from NetSuite to NetSuite Connector
Token-based authentication authenticates connections from NetSuite to NetSuite Connector. If you are setting up token-based authentication from NetSuite Connector to NetSuite, see Setting Up Token-Based Authentication from NetSuite Connector to NetSuite.
The setup uses an access token that you create in the NetSuite Connector portal. NetSuite stores the token as an API Secret. The SuiteApp references the secret by its Secret ID.
You need to save the access token as an API Secret in NetSuite instead of pasting the token value directly on the field. This ensures that the access token is securely stored.
Setting up token-based authentication between NetSuite Connector SuiteApp and NetSuite Connector involves the following steps:
-
Storing the SuiteApp Access Token as an API Secret in NetSuite
-
Entering the Secret ID in NetSuite Connector SuiteApp Configuration
Transition from Legacy Authentication
During the transition from legacy authentication, both token-based authentication and legacy username-and-password authentication remain available. This transition period lets you migrate to token-based authentication without disrupting existing integrations.
Existing SuiteApp configurations that use legacy username and password credentials continue to operate during the transition period. You don't need to change these configurations immediately. You also don't need to delete your current user name and token ID.
If you create a new configuration or edit and save an existing configuration, you must provide a valid SuiteApp access token for Token-Based Authentication.
After the transition period ends, credential-based authentication is no longer supported. All SuiteApp configurations must use Token-Based Authentication.
Migration timeline and any additional rollout guidance will be communicated to you separately.
Token-Based Authentication Setup Prerequisites
Before you begin, you need to ensure the following:
-
You can access the NetSuite Connector portal and the NetSuite account where the SuiteApp is installed.
-
You can create or request an API Secret in NetSuite.
-
You can securely save the access token when it is generated.
Creating the SuiteApp Access Token
You can generate the access token for the SuiteApp on the NetSuite Connector portal.
When you create a new token, it doesn't invalidate existing tokens. Multiple tokens can remain active at the same time.
To create the SuiteApp Access Token:
-
Log in to app.farapp.com.
-
Go to NetSuite > Settings > Credentials.
-
Create the Suite App Access Token.
-
Under SuiteApp Access Tokens section, enter a descriptive name in Token name.
-
Click Create Token.
-
-
Securely save the generated token value. You will need this value when you create the API secret in NetSuite.
Storing the SuiteApp Access Token as an API Secret in NetSuite
Use an API Secret in NetSuite to store the token value instead of entering the token value as plain text in the NetSuite Connector SuiteApp configuration field.
To store the SuiteApp Access Token as an API secret:
-
Go to Setup > Company > Preferences > API Secret.
-
Click Create New.
-
In the Create New Secret window, on the Details tab, enter a descriptive name for this secret in the Name field. Don't use sensitive or private information. It is shown on the list of API Secrets.
-
In the ID field, enter a script ID for this secret. You can use the ID to access it using SuiteScript. You should make this a descriptive ID with no spaces or special characters. NetSuite prefixes the script ID with 'custsecret'. Don't use sensitive or private information in this field. It is shown on the list of API Secrets.
-
In Password, enter the token value of the created SuiteApp token in Creating the SuiteApp Access Token. Alternatively, you can also load the token from a file.
-
Click Restrictions.
-
On the Restrictions tab, set up the API Secret Availability to the NetSuite Connector SuiteApp, scripts, and domains.
-
Check the Available to SuiteApp box.
-
In the SuiteApp ID field, enter com.netsuite.nsconnector. This field is required, and you can enter only one SuiteApp ID.
-
Check Allow for All Scripts.
-
Check Allow for All Domains.
-
-
Click Save.
Entering the Secret ID in NetSuite Connector SuiteApp Configuration
After creating the API Secret in NetSuite, you can enter the Secret ID in NetSuite Connector SuiteApp configuration.
To enter the secret ID in NetSuite Connector SuiteApp:
-
In NetSuite, go to Connector > Configuration > Setup.
-
Under Credentials, enter the API Secret ID in SuiteApp Access Token Secret ID.
-
Save the configuration.