Module: backend/secret

Provides implementation for the Vault Secret APIs

Extends

  • Vaulted

Methods


<inner> delete( [mountName])

Delete a secret from the generic backend

Parameters:
Name Type Argument Default Description
options.id string

unique identifier for the secret

options.token string <optional>

the authentication token

mountName string <optional>
secret

path name the generic secret backend is mounted on

Returns:
Type
Promise

<inner> read( [mountName])

Read / get a secret from the generic backend

Parameters:
Name Type Argument Default Description
options.id string

unique identifier for the secret

options.token string <optional>

the authentication token

mountName string <optional>
secret

path name the generic secret backend is mounted on

Returns:
Type
Promise

<inner> write( [mountName])

Write a secret to the generic backend

Parameters:
Name Type Argument Default Description
options.id string

unique identifier for the secret

options.body Object

containing the structure of the secret to store

options.token string <optional>

the authentication token

mountName string <optional>
secret

path name the generic secret backend is mounted on

Returns:
Type
Promise