Skip to main content

​
Overview

Allows the client to search for items in the vault. It is only possible to retrieve items that have been stored using the same account.

​
HTTP request

POST /Agent/Storage/SearchInVault

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"type": Optional(Str(PType)),
	"clientId": Optional(Str(PClientId)),
	"masked": Optional(Bool(PMasked)),
	"Tags":
	{
		"name": Required(Str(PTagName)),
		"value": Required(Str(PTagValue))
	}?[],
	"offset": Optional(Integer(POffset >= 0)),
	"maxCount": Optional(Integer(0 < PMaxCount <= 100))
}

​
Input parameters

ParameterDescription
PTypeAn optional type string. Can be null. Returns items matching this type, if provided.
PClientIdAn optional Client Identifier. Can be null. Returns items matching this identifier, if provided.
PMaskedIf the masked information should be returned (true) or the full information (false).
PTagNameThe name of the information tag. Only items containing this tag will be returned.
PTagValueThe value of the information tag. Only items containing the named tag, with either the value or the masked value matching this value will be returned.
POffsetIgnore the first POffset number of items found.
PMaxCountMaximum number of items to return.

​
Response (JSON)

{
	"ResultSet": Optional(
		{
			"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))
			}[]
		}
		[])
}

​
Response parameters

ParameterDescription
PCreatedWhen the vault item was first created.
PUpdatedWhen the vault item was last updated.
PTypeAn optional type string. Client can define type strings to separate different types of information into different items.
PClientIdAn optional Client Identifier used by the agent to separate sensitive information between clients it serves.
PVaultIdThe identifier of the vault item.
PNameThe name of the information tag.
PValueThe value or masked value of the information tag, depending on PMasked.

​
Notes

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