Skip to main content
GET
/
vaults
Get all Vaults
curl --request GET \
  --url http://localhost:8080/v1/vaults \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "attributeVersion": 123,
    "contentVersion": 123,
    "items": 123,
    "type": "USER_CREATED",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
filter
string

Filter the Vault collection based on Vault name using SCIM eq filter

Example:

"name eq \"Some Vault Name\""

Response

OK

​
id
string
Pattern: ^[\da-z]{26}$
​
name
string
​
description
string
​
attributeVersion
integer

The vault version

​
contentVersion
integer

The version of the vault contents

​
items
integer

Number of active items in the vault

​
type
enum<string>
Available options:
USER_CREATED,
PERSONAL,
EVERYONE,
TRANSFER
​
createdAt
string<date-time>
​
updatedAt
string<date-time>