Secrets Management

You can store, manage, and reference API secrets in NetSuite at Setup > Company > Preferences > API Secrets. You can then reference these secrets in third party integrations, preventing the need for plaintext secrets in scripts. API secrets include hashes, passwords, keys, and other secrets for managing digital authentication credentials. NetSuite accepts secrets up to 1,000,000 characters.

Secret owners can limit access for other users or allow access for a specific SuiteApp. Secrets are only referenced by script ID, and the password value can't be displayed. A secret can't be used by more than one SuiteApp. If you need to share a password across multiple SuiteApps, you must create multiple secrets with the same password.

Only SuiteScript 2.x APIs can use the secret. For a list of supported SuiteScript 2.x modules, see Supported SuiteScript 2.x modules.

Note:

A secret can only be updated in the same account where it was created. Ensure that you don't enter a secret in an account that will be deleted in the future; when a shared secret is deleted, you'll be unable to create another shared secret with same id.

In SDF, you can add the customization object custsecret_example_id.xml, which contains the line <secret scriptid="custsecret_example_id"/>. You can only import a secret customization object to your SuiteCloud project if the Available to SuiteApp box is checked. For more information about this setting, see Creating Secrets. For more information about customization objects, see SDF Custom Object and File Development in SuiteCloud Projects.

Only administrators and users with the Secrets Management permission can manage secrets. For more information, see Access to Secrets.

Note:

To maintain higher security in comparison to using the username and password combination, you can use an authentication API based on OAuth.

Related Topics

General Notices