Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Javascript Library

/Storage/GetFromVault

Allows the client to get an item from the vault. It is only possible to retrieve items that have been stored using the same account.

JSON

Request
{
	"vaultId": Required(Str(PVaultId)),
	"masked": Optional(Bool(PMasked))
}
Response (if successful)
{
	"vaultId": Required(Str(PVaultId)),
	"type": Optional(Str(PType)),
	"clientId": Optional(Str(PClientId)),
	"created": Required(DateTime(PCreated)),
	"updated": Required(DateTime(PUpdated)),
	"Tags":
	{
		"name": Required(Str(PName)),
		"value": Required(Str(PValue))
	}[]
}

XML

Request
<GetFromVault xmlns="https://waher.se/Schema/BrokerAgent.xsd"
              vaultId=(Required(Str(PVaultId)))
              masked=(Optional(Bool(PMasked))) />
Response (if successful)
<VaultItem xmlns="https://waher.se/Schema/BrokerAgent.xsd"
		   vaultId=(Required(Str(PVaultId)))
		   type=(Optional(Str(PType)))
		   clientId=(Optional(Str(PClientId)))
		   created=(Required(DateTime(PCreated)))
		   updated=(Required(DateTime(PUpdated)))>
	<Tags>
		<[
		<Tag name=(Required(Str(PName)))
				 value=(Required(Str(PValue))) />[]
		]>
	</Tags>
</VaultItem>

Input Parameters

Parameter Description
PVaultId Identifier of the vault item to retrieve.
PMasked If the masked information should be retrieved (true) or the full information (false).

Response Parameters

Parameter Description
PCreated When the vault item was first created.
PUpdated When the vault item was last updated.
PType An optional type string. 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.
PVaultId The identifier of the vault item.
PName The name of the information tag.
PValue The value or masked value of the information tag, depending on PMasked.

Note: If requesting masked information, but no masked value has been stored, the full value will be returned instead for the corresponding tags.

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource. 

var Response = await AgentAPI.Storage.GetFromVault(VaultId,Masked);
Test


Request Payload:

Response Payload: