Skip to main content
POST
/
vault
/
provision
cURL
curl --request POST \
  --url https://api.useanima.sh/v1/vault/provision \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>"
}
'
{
  "id": "<string>",
  "agentId": "<string>",
  "orgId": "<string>",
  "vaultUserId": "<string>",
  "vaultOrgId": "<string>",
  "collectionId": "<string>",
  "credentialCount": 1,
  "lastSyncAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Input for provisioning a new agent vault

agentId
required

Agent identifier to provision a vault for — master key only

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

Provisioned vault details for an agent

id
string
required

Unique vault record identifier

agentId
string
required

Agent the vault belongs to

orgId
string
required

Organization the vault belongs to

vaultUserId
string | null
required

Vault backend user identifier

vaultOrgId
string | null
required

Vault backend organization identifier

collectionId
string | null
required

Default collection identifier in the vault

status
enum<string>
required

Current vault operational status

Available options:
ACTIVE,
LOCKED,
ERROR
credentialCount
integer
required

Total number of credentials stored

Required range: x >= 0
lastSyncAt
string<date-time> | null
required

Timestamp of the last vault synchronization

createdAt
string<date-time>
required

Timestamp when the vault was provisioned

updatedAt
string<date-time>
required

Timestamp when the vault was last updated