vault.secret.database — com.amperity/vault-clj 2.1.583

The database secrets engine is used to manage dynamically-issued credentials for users of a database backend such as mysql, postgresql, mongodb, etc. The vault server uses a privileged 'root' user to create new users with randomized passwords on-demand for callers.

Reference: https://www.vaultproject.io/api-docs/secret/databases

API clj protocol

The database secrets engine is used to manage dynamic users in a backing database system.

generate-credentials! clj

(generate-credentials! client role-name)

(generate-credentials! client role-name opts)

Generate a new set of dynamic credentials based on the named role.

Options:

• :refresh? (boolean)

  Always make a call for fresh data, even if a cached secret lease is available.

• :renew? (boolean)

  If true, attempt to automatically renew the credentials lease when near expiry. (Default: false)

• :renew-within (integer)

  Renew the secret when within this many seconds of the lease expiry. (Default: 60)

• :renew-increment (integer)

  How long to request credentials be renewed for, in seconds.

• :on-renew (fn)

  A function to call with the updated lease information after the credentials have been renewed.

• :rotate? (boolean)

  If true, attempt to read a new set of credentials when they can no longer be renewed. (Default: false)

• :rotate-within (integer)

  Rotate the secret when within this many seconds of the lease expiry. (Default: 60)

• :on-rotate (fn)

  A function to call with the new credentials after they have been rotated.

• :on-error (fn)

  A function to call with any exceptions encountered while renewing or rotating the credentials.

with-mount clj

(with-mount client mount)

Return an updated client which will resolve calls against the provided mount instead of the default. Passing nil will reset the client to the default.

default-mount clj

Default mount point to use if one is not provided.