keyControl.deleteKey(options)

Note:

The content in this help topic pertains to SuiteScript 2.0 and SuiteScript 2.1.

Method Description	Deletes a key.
Returns	Object
Supported Script Types	Server scripts For additional information, see SuiteScript 2.x Script Types.
Governance	10 units
Module	N/keyControl Module
Since	2019.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.scriptId	string	required	The script ID of the key to be deleted. Using Key.save() and keyControl.findKeys(options) returns the script ID.	2019.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/keyControl Module Script Samples.

              // Add additional code
...
var keyId = keyControl.deleteKey({
    scriptId: 'key_test'
});;
...
// Add additional code 

            

Related Topics

N/keyControl Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices