Key Object Members of keyControl Module in SuiteScript

The keyControl module in SuiteScript provides developers with mechanisms to create and manage keys programmatically. This article outlines the key object members available and their specific descriptions, return types, and supported script types.

What Are Key Object Members?

Key object members are properties and methods associated with the keyControl.Key object in SuiteScript. These members allow you to interact with keys used within NetSuite servers.

Key Object Members Overview

The following table summarizes the key object members, their types, and descriptions:

Methods

The method available for this object is:

• Key.save(): This method is used to save the key. Its return type is an object.

Example Usage

To create and modify a key using the keyControl module, you might use the following code snippet:

1// Add additional code
2...
3var key = keyControl.createKey();
4key.file = file.load(422); // ID of the file containing the private key (id_ecdsa or id_rsa)
5...
6// Add additional code

Conclusion

The keyControl module plays a crucial role in securely managing keys within SuiteScripts. By familiarizing yourself with the key object members, you can effectively utilize keys to enhance your integration scripts.

Key Takeaways

• The keyControl.Key object allows for management of keys in SuiteScript.
• Key members include file, password, script ID, and restrictions.
• The Key.save() method is crucial for saving changes to the key.