Pular para o conteúdo

Vaults

A vault is a component that maintains secret key material and is responsible for the creation and signing process of outgoing ledger transactions.

A vault executes transaction orders once they are fully approved and delivers the signed ledger transaction to the system for broadcast. A single instance of Harmonize can hold multiple vaults, which may provide complementary features (e.g., various distributed ledger protocols), key stores (e.g., different hardware vendors or multi-party computation-based algorithms), or key isolation (e.g., connected, or air-gapped). For example, a system can leverage a hot vault (for hot accounts) and an air-gapped vault (for cold accounts). Accounts within the system are associated with specific vaults.

The registration of the public key of a vault, publicKey, allows the system to verify any information returned by the vault.

The locking of a vault prevents the execution of any transaction order related to the specific vault.

Operações

List vaults

Requisição

Segurança
httpAuth
Consulta
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""alias""lock""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
aliasstring, non-empty

Return entities with aliases that contains or equals to provided alias.

Exemplo:alias=alias1
publicKeystring, non-empty

Return entities matching given public key. It should be provided in Base64 format.

Exemplo:publicKey=MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENYOHIq0Pgg5ERTQOahVK3I45+efvsRvw1rcyk+oqpnj7qkXSEis3BbgnwBY42uolGg7lPbusmAMWVDYRqKMApQ==
lockArray of strings

Return entities matching given lock status.

Items Enum:"Unlocked""Locked""Archived"
Exemplo:lock=Locked&lock=Unlocked
metadata.createdBystring, (uuid)

Return entities that were created by matching user.

Exemplo:metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49
metadata.lastModifiedBystring, (uuid)

Return entities that were last modified by matching user.

Exemplo:metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
metadata.descriptionstring, >= 0 characters

Return entities with descriptions that contains or equals to provided description.

Exemplo:metadata.description=description1
metadata.customPropertiesArray of strings

Return entities that contains provided custom properties.

Exemplo:metadata.customProperties=key1:value1&metadata.customProperties=key2:value2
additionalDetails.processingStatusstring

Return entities matching given processing status.

Enum:"Pending""Preparing""Completed"
Exemplo:additionalDetails.processingStatus=Pending
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/devbox/v1/vaults?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&alias=alias1&publicKey=MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENYOHIq0Pgg5ERTQOahVK3I45%2BefvsRvw1rcyk%2Boqpnj7qkXSEis3BbgnwBY42uolGg7lPbusmAMWVDYRqKMApQ%3D%3D&lock=Locked%2CUnlocked&metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49&metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&metadata.description=description1&metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2&additionalDetails.processingStatus=Pending' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json
itemsArray of objectsobrigatório
countinteger, (int32)obrigatório
currentStartingAfterstring
nextStartingAfterstring
Resposta
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}