Documentation for definitions

Definition Item

Diagram

Type

object

Properties

Name	Occurrence
category createdAt favorite id lastEditedBy state tags title updatedAt urls vault version	required optional optional optional optional optional optional optional optional optional required optional

Additional Properties

true

Used by

Schema
Item
FullItem
path-vaults_vaultUuid_items_operation-get_response-200_application_json

Source


 "Item": {
  "type": "object",
  "required": [
    "vault",
    "category"
  ],
  "properties": {
    "category": {
      "type": "string",
      "enum": [
        "SOCIAL_SECURITY_NUMBER",
        "SECURE_NOTE",
        "OUTDOOR_LICENSE",
        "WIRELESS_ROUTER",
        "API_CREDENTIAL",
        "DRIVER_LICENSE",
        "EMAIL_ACCOUNT",
        "CREDIT_CARD",
        "IDENTITY",
        "MEMBERSHIP",
        "SOFTWARE_LICENSE",
        "BANK_ACCOUNT",
        "PASSWORD",
        "DATABASE",
        "SERVER",
        "CUSTOM",
        "DOCUMENT",
        "LOGIN",
        "REWARD_PROGRAM",
        "PASSPORT"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "favorite": {
      "default": false,
      "type": "boolean"
    },
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}$"
    },
    "lastEditedBy": {
      "type": "string",
      "readOnly": true
    },
    "state": {
      "readOnly": true,
      "type": "string",
      "enum": [
        "ARCHIVED",
        "DELETED"
      ]
    },
    "tags": {
      "type": "array",
      "items": {}
    },
    "title": {"type": "string"},
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "urls": {
      "type": "array",
      "example": [
        {
          "href": "https://example.com",
          "primary": true
        },
        {"href": "https://example.org"}
      ],
      "items": {}
    },
    "vault": {
      "type": "object",
      "required": ["id"],
      "properties": {}
    },
    "version": {"type": "integer"}
  }
}

Definition category

Diagram

Type

string

Enumeration

Values
SOCIAL_SECURITY_NUMBER
SECURE_NOTE
OUTDOOR_LICENSE
WIRELESS_ROUTER
API_CREDENTIAL
DRIVER_LICENSE
EMAIL_ACCOUNT
CREDIT_CARD
IDENTITY
MEMBERSHIP
SOFTWARE_LICENSE
BANK_ACCOUNT
PASSWORD
DATABASE
SERVER
CUSTOM
DOCUMENT
LOGIN
REWARD_PROGRAM
PASSPORT

Used by

Schema
Item

Source


 "category": {
  "type": "string",
  "enum": [
    "SOCIAL_SECURITY_NUMBER",
    "SECURE_NOTE",
    "OUTDOOR_LICENSE",
    "WIRELESS_ROUTER",
    "API_CREDENTIAL",
    "DRIVER_LICENSE",
    "EMAIL_ACCOUNT",
    "CREDIT_CARD",
    "IDENTITY",
    "MEMBERSHIP",
    "SOFTWARE_LICENSE",
    "BANK_ACCOUNT",
    "PASSWORD",
    "DATABASE",
    "SERVER",
    "CUSTOM",
    "DOCUMENT",
    "LOGIN",
    "REWARD_PROGRAM",
    "PASSPORT"
  ]
}

Definition createdAt

Diagram

Type

string

Constraints

Format : date-time

Used by

Schema
Item

Source


 "createdAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Definition favorite

false

Diagram

Type

boolean

Used by

Schema
Item

Source


 "favorite": {
  "default": false,
  "type": "boolean"
}

Definition id

Diagram

Type

string

Constraints

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

Used by

Schema
Item

Source


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

Definition lastEditedBy

Diagram

Type

string

Used by

Schema
Item

Source


 "lastEditedBy": {
  "type": "string",
  "readOnly": true
}

Definition state

Diagram

Type

string

Enumeration

Values
ARCHIVED
DELETED

Used by

Schema
Item

Source


 "state": {
  "readOnly": true,
  "type": "string",
  "enum": [
    "ARCHIVED",
    "DELETED"
  ]
}

Definition tags

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items
definitions_Item.html#/definitions/Item/properties/tags/items

Additional Items

true

Used by

Schema
Item

Source


 "tags": {
  "type": "array",
  "items": {"type": "string"}
}

Definition tags/items

Diagram

Type

string

Used by

Schema
Item/properties/tags

Source


 "items": {"type": "string"}

Definition title

Diagram

Type

string

Used by

Schema
Item

Source


 "title": {"type": "string"}

Definition updatedAt

Diagram

Type

string

Constraints

Format : date-time

Used by

Schema
Item

Source


 "updatedAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Definition urls

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items
definitions_Item.html#/definitions/Item/properties/urls/items

Additional Items

true

Used by

Schema
Item

Source


 "urls": {
  "type": "array",
  "example": [
    {
      "href": "https://example.com",
      "primary": true
    },
    {"href": "https://example.org"}
  ],
  "items": {
    "type": "object",
    "required": ["href"],
    "properties": {
      "href": {"type": "string"},
      "primary": {"type": "boolean"}
    }
  }
}

Definition urls/items

Diagram

Type

object

Properties

Name	Occurrence
href primary	required optional

Additional Properties

true

Used by

Schema
Item/properties/urls

Source


 "items": {
  "type": "object",
  "required": ["href"],
  "properties": {
    "href": {"type": "string"},
    "primary": {"type": "boolean"}
  }
}

Definition href

Diagram

Type

string

Used by

Schema
Item/properties/urls/items

Source


 "href": {"type": "string"}

Definition primary

Diagram

Type

boolean

Used by

Schema
Item/properties/urls/items

Source


 "primary": {"type": "boolean"}

Definition vault

Diagram

Type

object

Properties

Name	Occurrence
id	required

Additional Properties

true

Used by

Schema
Item

Source


 "vault": {
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}$"
    }
  }
}

Definition id

Diagram

Type

string

Constraints

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

Used by

Schema
Item/properties/vault

Source


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

Definition version

Diagram

Type

number

Used by

Schema
Item

Source


 "version": {"type": "integer"}