Provides implementation for the Vault Audit APIs
Extends: Vaulted
audit~getAuditMounts() ⇒ Promise
Gets the list of mounted audit backends for the vault.
Kind : inner method of audit
Resolve : [Mounts]
Resolves with current list of mounted audit backends
Reject : Error
An error indicating what went wrong
audit~enableAudit(options) ⇒ Promise
Enable a specific audit backend for use with the vault.
Kind : inner method of audit
Resolve : success
Reject : Error
An error indicating what went wrong
Param
Type
Description
options
Object
object of options to send to API request
options.id
string
unique identifier for the audit mount
options.body
Object
holds the attributes passed as inputs
options.body.type
string
the type of audit ('file', 'syslog')
[options.body.description]
string
a description of the audit backend for operators.
[options.body.options]
Object
options for configuring a specific type of audit backend
audit~disableAudit(options) ⇒ Promise
Disable a specific audit backend from the vault.
Kind : inner method of audit
Resolve : success
Reject : Error
An error indicating what went wrong
Param
Type
Description
options
Object
object of options to send to API request
options.id
string
unique identifier for the audit mount
audit~enableFileAudit(options) ⇒ Promise
Convenience method to enable the file
audit backend for use with the vault.
Kind : inner method of audit
Resolve : success
Reject : Error
An error indicating what went wrong
Param
Type
Default
Description
options
Object
object of options to send to API request
options.id
string
unique identifier for the file audit mount
options.body
Object
holds the attributes passed as inputs
options.body.path
string
the directory where to write the audit files
[options.body.description]
string
a description of the file audit backend for operators.
[options.body.log_raw]
Object
false
Should security sensitive information be logged raw.
audit~enableSyslogAudit(options) ⇒ Promise
Convenience method to enable the syslog
audit backend for use with the vault.
Kind : inner method of audit
Resolve : success
Reject : Error
An error indicating what went wrong
Param
Type
Default
Description
options
Object
object of options to send to API request
options.id
string
unique identifier for the syslog audit mount
options.body
Object
holds the attributes passed as inputs
[options.body.description]
string
a description of the syslog audit backend for operators.
[options.body.facility]
string
"AUTH"
The syslog facility to use.
[options.body.tag]
string
"vault"
The syslog tag to use.
[options.body.log_raw]
Object
false
Should security sensitive information be logged raw.