Module: auth/appid

Extends

• Vaulted

Methods

---

<inner> appLogin( [mountName])

Authenticates the user of the app using the app-id authentication backend.

Parameters:

Name	Type	Argument	Default	Description
options.body.app_id	string			the app id
options.body.user_id	string			the user id
options.token	string	<optional>		the authentication token
mountName	string	<optional>	app-id	path name the app-id auth backend is mounted on

Returns:

Type

Promise

---

<inner> createApp( [mountName])

Creates the specified app in the app-id auth backend of the vault.

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the app
options.body.value	string			the policy id
options.body.display_name	string			human-readable name of the app.
options.token	string	<optional>		the authentication token
mountName	string	<optional>	app-id	path name the app-id auth backend is mounted on

Returns:

Type

Promise

---

<inner> createUser( [mountName])

Creates the specified user in the app-id auth backend of the vault.

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the user
options.body.value	string			the app id
options.token	string	<optional>		the authentication token
mountName	string	<optional>	app-id	path name the app-id auth backend is mounted on

Returns:

Type

Promise

---

<inner> deleteApp( [mountName])

Deletes the specified app from the app-id auth backend of the vault.

Parameters:

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

Returns:

Type

Promise

---

<inner> deleteUser( [mountName])

Deletes the specified user from the app-id auth backend of the vault.

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the user
options.token	string	<optional>		the authentication token
mountName	string	<optional>	app-id	path name the app-id auth backend is mounted on

Returns:

Type

Promise

---

<inner> getApp( [mountName])

Retrieve the specified app using the app id.

Parameters:

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

Returns:

Type

Promise

---

<inner> getUser( [mountName])

Retrieve the specified user using the user id.

Parameters:

Name	Type	Argument	Default	Description
options.id	string			unique identifier for the user
options.token	string	<optional>		the authentication token
mountName	string	<optional>	app-id	path name the app-id auth backend is mounted on

Returns:

Type

Promise