Module: backend/consul

Extends

• Vaulted

Methods

---

<inner> configConsulAccess( [mountName])

Configures the access information for Consul secret backend

Parameters:

Name	Type	Argument	Default	Description
options.body.address	string			address of the Consul instance, provided as host:port
options.body.token	string			Consul ACL token to use; must be a management type token
options.body.scheme	string	<optional>	HTTP	URL scheme to use
options.token	string	<optional>		the authentication token
mountName	string	<optional>	consul	path name the consul secret backend is mounted on

Returns:

Type

Promise

---

<inner> createConsulRole( [mountName])

Creates or updates the Consul role definition

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the consul role
options.body.policy	string			base64 encoded Consul ACL policy
options.body.token_type	string	<optional>	client	type of token to create using this role ('client', 'management')
options.body.lease	string	<optional>		lease value provided as a string duration with time suffix
options.token	string	<optional>		the authentication token
mountName	string	<optional>	consul	path name the consul secret backend is mounted on

Returns:

Type

Promise

---

<inner> deleteConsulRole( [mountName])

Removes a specified Consul role definition

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the consul role
options.token	string	<optional>		the authentication token
mountName	string	<optional>	consul	path name the consul secret backend is mounted on

Returns:

Type

Promise

---

<inner> generateConsulRoleToken( [mountName])

Generate a dynamic Consul token based on the role definition

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the consul role
options.token	string	<optional>		the authentication token
mountName	string	<optional>	consul	path name the consul secret backend is mounted on

Returns:

Type

Promise

---

<inner> getConsulRole( [mountName])

Retrieve a specified Consul role definition

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the consul role
options.token	string	<optional>		the authentication token
mountName	string	<optional>	consul	path name the consul secret backend is mounted on

Returns:

Type

Promise