Store in vault - Neuron Agent API

Overview

Allows the client to store information security in the vault. The information is stored encrypted is secure storage, complying with stricty industry standards such as PCI/DSS. The resource can be used to store new information, or to update existing information. Masks can be provided to the information, so that when it is retrieved later, only the masked information is returned. In return for storing the information in the vault, an opaque identifier is returned. This identifier can be safely stored by the client, and used to retrieve the information later. This allows the client to avoid storing sensitive information locally.

HTTP request

POST /Agent/Storage/StoreInVault

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"type": Required(Str(PType)),
	"clientId": Optional(Str(PClientId)),
	"vaultId": Optional(Str(PVaultId)),
	"Tags":
	{
		"name": Required(Str(PTagName)),
		"value": Required(Str(PTagValue)),
		"masked": Optional(Str(PTagMaskedValue))
	}?[]
}

Input parameters

Parameter	Description
PType	An optional type string. Can be null. Client can define type strings to separate different types of information into different items.
PClientId	An optional Client Identifier used by the agent to separate sensitive information between clients it serves. Can be null.
PVaultId	An optional Vault Identifier. Can be null, which which case a new vault item is created. If provided, an existing vault item is upadted.
PTagName	The name of the information tag.
PTagValue	The value of the information tag. This value will be returned if unmasked values are requested.
PTagMaskedValue	The masked value of the information tag. This value will be returned if masked values are requested.

Response (JSON)

{
	"created": Required(DateTime(PCreated)),
	"updated": Required(DateTime(PUpdated)),
	"vaultId": Required(Str(PVaultId))
}

Response parameters

Parameter	Description
PCreated	When the vault item was created.
PUpdated	When the vault item was last updated.
PVaultId	The Identifier of the vault item. This identifier be safely stored by the client, in order to retrieve the information in the item later.

Notes

This endpoint uses the request schema notation described in Pattern matching.

​Overview

​HTTP request

​Authentication

​Request (JSON)

​Input parameters

​Response (JSON)

​Response parameters

​Notes