Node-RED
docs • api • modules• 1.3.2

@node-red/runtime.settings

Functions

generateUserKey ( opts )
getRuntimeSettings ( opts )
getUserKey ( opts )
getUserKeys ( opts )
getUserSettings ( opts )
removeUserKey ( opts )
updateUserSettings ( opts )

generateUserKey(opts) → {Promise.<String>}

Generates a new ssh key pair

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
name User

the id of the key to return
password User

(optional) the password for the key pair
comment User

(option) a comment to associate with the key pair
size User

(optional) the size of the key. Default: 2048
req Object

the request to log (optional)
Returns:
Type:
Promise.<String>
  • the id of the generated key

getRuntimeSettings(opts) → {Promise.<Object>}

Gets the runtime settings object

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
req Object

the request to log (optional)
Returns:
Type:
Promise.<Object>
  • the runtime settings

getUserKey(opts) → {Promise.<String>}

Gets a user's ssh public key

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
id User

the id of the key to return
req Object

the request to log (optional)
Returns:
Type:
Promise.<String>
  • the user's ssh public key

getUserKeys(opts) → {Promise.<Object>}

Gets a list of a user's ssh keys

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
req Object

the request to log (optional)
Returns:
Type:
Promise.<Object>
  • the user's ssh keys

getUserSettings(opts) → {Promise.<Object>}

Gets an individual user's settings object

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
req Object

the request to log (optional)
Returns:
Type:
Promise.<Object>
  • the user settings

removeUserKey(opts) → {Promise}

Deletes a user's ssh key pair

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
id User

the id of the key to delete
req Object

the request to log (optional)
Returns:
Type:
Promise
  • resolves when deleted

updateUserSettings(opts) → {Promise.<Object>}

Updates an individual user's settings object.

Parameters:
Name Type Description
opts Object
Name Type Description
user User

the user calling the api
settings Object

the updates to the user settings
req Object

the request to log (optional)
Returns:
Type:
Promise.<Object>
  • the user settings

Node-RED: Low-code programming for event-driven applications.

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

The OpenJS Foundation | Terms of Use | Privacy Policy | OpenJS Foundation Bylaws | Trademark Policy | Trademark List | Cookie Policy