Documentation for paths

Paths

Items

Tag description

patch

/vaults/{vaultUuid}/items/{itemUuid}

Parameters

required

itemUuid

The UUID of the Item to update

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

required

vaultUuid

The UUID of the Vault the item is in

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

OK - Item updated. If no Patch operations were provided, Item is unmodified.

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Item not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

RequestBody

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Patch"}

Security

0{"ConnectToken":[]}

get

/vaults/{vaultUuid}/items/{itemUuid}

Parameters

required

itemUuid

The UUID of the Item to fetch

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

required

vaultUuid

The UUID of the Vault to fetch Item from

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Item not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}

delete

/vaults/{vaultUuid}/items/{itemUuid}

Parameters

required

vaultUuid

The UUID of the Vault the item is in

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

required

itemUuid

The UUID of the Item to update

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

204

Successfully deleted an item

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Item not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}

put

/vaults/{vaultUuid}/items/{itemUuid}

Parameters

required

itemUuid

The UUID of the Item to update

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

required

vaultUuid

The UUID of the Item's Vault

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

400

Unable to create item due to invalid input

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Item not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

RequestBody

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

Security

0{"ConnectToken":[]}

post

/vaults/{vaultUuid}/items

Parameters

required

vaultUuid

The UUID of the Vault to create an Item in

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

400

Unable to create item due to invalid input

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Item not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

RequestBody

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/FullItem"}

Security

0{"ConnectToken":[]}

get

/vaults/{vaultUuid}/items

Parameters

optional

filter

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

[ query ]

Type

string

Source


{
  "type": "string",
  "example": "title eq \"Some Item Name\""
}

required

vaultUuid

The UUID of the Vault to fetch Items from

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Item"}
}

Type

empty schema

Used by

Schema

Source


 "items": {"ref": "#/components/schemas/Item"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Vault not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}

Vaults

Tag description

get

/vaults

Parameters

optional

filter

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

[ query ]

Type

string

Source


{
  "type": "string",
  "example": "name eq \"Some Vault Name\""
}

Responses

200

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/Vault"}
}

Type

empty schema

Used by

Schema

Source


 "items": {"ref": "#/components/schemas/Vault"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}

get

/vaults/{vaultUuid}

Parameters

required

vaultUuid

The UUID of the Vault to fetch Items from

[ path ]

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


{
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Responses

200

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/Vault"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

403

Unauthorized access

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

404

Vault not found

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}

Activity

Tag description

get

/activity

Parameters

optional

limit

How many API Events should be retrieved in a single request.

[ query ]

Type

number

Constraints

Default : 50

Source


{
  "type": "integer",
  "default": 50,
  "example": 10
}

optional

offset

How far into the collection of API Events should the response start

[ query ]

Type

number

Constraints

Default : 0

Source


{
  "type": "integer",
  "default": 0,
  "example": 50
}

Responses

200

application/json

Type

array

Constraints

Unique Items : false

Array Items

Items

items.html#/items

Source


{
  "type": "array",
  "items": {"ref": "#/components/schemas/APIRequest"}
}

Type

empty schema

Used by

Schema

Source


 "items": {"ref": "#/components/schemas/APIRequest"}

401

Invalid or missing token

application/json

Type

empty schema

Source


{"ref": "#/components/schemas/ErrorResponse"}

Security

0{"ConnectToken":[]}