Module: leases

Provides implementation for the Vault Renew/Revoke Leases APIs

Extends

  • Vaulted

Methods


<inner> renewLease()

Renew the lease (extend) on a secret

Parameters:
Name Type Argument Description
options.id string

unique identifier for the lease

options.body.increment string <optional>

requested amount of time in seconds to extend the lease.

options.token string <optional>

the authentication token

Returns:

Promise which is resolved to the renewed secret.

Type
Promise

<inner> revokeLease()

Revoke the lease on a secret immediately.

Parameters:
Name Type Argument Description
options.id string

unique identifier for the lease

options.token string <optional>

the authentication token

Returns:
Type
Promise

<inner> revokeLeasePrefix()

Revoke the lease on all secrets under the specified prefix immediately.

Parameters:
Name Type Argument Description
options.id string

secret path prefix

options.token string <optional>

the authentication token

Returns:
Type
Promise