Help Center

Menu

plugin.[pluginId].encrypted.[secretKey]

Plugin configuration fields for storing secret information such as a password in an encrypted format.

Key: plugin.[pluginId].encrypted.[secretKey]
Type: ConfigPassword
Can be set in: profile.cfg, collection.cfg
Notes: This option is used by both collections and profiles.

Description

Plugin encrypted keys facilitate the storage of secret information (such as passwords and tokens) for use in a plugin.

Any data stored in an encrypted key will be automatically encrypted and decrypted by the plugin. The administration dashboard will automatically obfuscate the value of any encrypted fields.

An encrypted plugin key is specified using the following format:

plugin.PLUGIN_ID.encrypted.KEY=VALUE

where:

  • PLUGIN-ID is the ID of the plugin.

  • KEY is the key name.

  • VALUE is the value that is stored in an encrypted format.

Default Value

This field is not set by default

Examples

Configure the plugin 'exampleplugin' to have a secret token called 'token'.

plugin.exampleplugin.encrypted.token=password2