mynt

module function · N/keyControl

createKey()

keyControl.createKey(options)

Creates a key.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A suitescript api
Signature
keyControl.createKey(options)
Returns
keyControl.Key
Governance
10 units
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2019.2
call shapefrom Oracle's parameter table
1keyControl.createKey({2    file:         /* number, required */,3    name:         /* string, required */,4    description:  /* string, optional */,5    password:     /* string, optional */,6    scriptId:     /* string, optional */,7    restrictions: /* number[] or string[], optional */8});
Oracle reference for this method
ParameterTypeRequiredDescription
options.filenumberrequiredThe internal ID of the File Cabinet file with the key. The key must be in PEM format.
options.namestringrequiredThe name of the key.
options.descriptionstringoptionalThe description of the key.
options.passwordstringoptionalThe password that is associated with the key. The script ID of an API secret is accepted for this value. For more information, see Secrets Management .
options.scriptIdstringoptionalThe script ID for the newly-created key. NetSuite prepends this ID with 'custkey'. If you do not provide an ID, one is auto-generated.
options.restrictionsnumber[] or string[]optionalThe array of employee internal IDs selected in the Restricted to Employees field for a key. If you select employees, only those employees can use this key.
B mynt syntax

No Mynt syntax yet.

Nothing in the language compiles to keyControl.createKey(options) today. How should it read?

C community proposals

Competing syntax for createKey, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D suggest an alternative

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/keyControl · keyControl.createKey(options)

Suggest syntax for createKey