"APIRequest": {
  "type": "object",
  "description": "Represents a request that was made to the API. Including what Token was used and what resource was accessed.",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "The unique id used to identify a single request."
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The time at which the request was processed by the server.",
      "readOnly": true
    },
    "action": {
      "type": "string",
      "enum": [
        "READ",
        "DELETE",
        "CREATE",
        "UPDATE"
      ]
    },
    "result": {
      "type": "string",
      "enum": [
        "SUCCESS",
        "DENY"
      ]
    },
    "actor": {
      "type": "object",
      "properties": {}
    },
    "resource": {
      "type": "object",
      "properties": {}
    }
  }
}

 "requestId": {
  "type": "string",
  "description": "The unique id used to identify a single request."
}

 "timestamp": {
  "type": "string",
  "format": "date-time",
  "description": "The time at which the request was processed by the server.",
  "readOnly": true
}

 "action": {
  "type": "string",
  "enum": [
    "READ",
    "DELETE",
    "CREATE",
    "UPDATE"
  ]
}

 "result": {
  "type": "string",
  "enum": [
    "SUCCESS",
    "DENY"
  ]
}

 "actor": {
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "account": {"type": "string"},
    "jti": {"type": "string"},
    "userAgent": {"type": "string"},
    "requestIp": {"type": "string"}
  }
}

 "id": {"type": "string"}

 "account": {"type": "string"}

 "jti": {"type": "string"}

 "userAgent": {"type": "string"}

 "requestIp": {"type": "string"}

 "resource": {
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "ITEM",
        "VAULT"
      ]
    },
    "vault": {
      "type": "object",
      "properties": {}
    },
    "item": {
      "type": "object",
      "properties": {}
    },
    "itemVersion": {"type": "integer"}
  }
}

 "type": {
  "type": "string",
  "enum": [
    "ITEM",
    "VAULT"
  ]
}

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

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

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

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

 "itemVersion": {"type": "integer"}

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

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

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

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

 "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"
  ]
}

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

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

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

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

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

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

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

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

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

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

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

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

 "Field": {
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {"type": "string"},
    "section": {
      "type": "object",
      "properties": {}
    },
    "type": {
      "default": "STRING",
      "type": "string",
      "enum": [
        "TOTP",
        "DATE",
        "MONTH_YEAR",
        "CONCEALED",
        "STRING",
        "MENU",
        "EMAIL",
        "URL"
      ]
    },
    "purpose": {
      "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
      "type": "string",
      "enum": [
        "",
        "NOTES",
        "PASSWORD",
        "USERNAME"
      ]
    },
    "label": {"type": "string"},
    "value": {"type": "string"},
    "generate": {
      "description": "If value is not present then a new value should be generated for this field",
      "default": false,
      "type": "boolean"
    },
    "recipe": {"ref": "#/components/schemas/GeneratorRecipe"},
    "entropy": {
      "type": "number",
      "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
      "readOnly": true
    }
  }
}

 "id": {"type": "string"}

 "section": {
  "type": "object",
  "properties": {
    "id": {"type": "string"}
  }
}

 "id": {"type": "string"}

 "type": {
  "default": "STRING",
  "type": "string",
  "enum": [
    "TOTP",
    "DATE",
    "MONTH_YEAR",
    "CONCEALED",
    "STRING",
    "MENU",
    "EMAIL",
    "URL"
  ]
}

 "purpose": {
  "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
  "type": "string",
  "enum": [
    "",
    "NOTES",
    "PASSWORD",
    "USERNAME"
  ]
}

 "label": {"type": "string"}

 "value": {"type": "string"}

 "generate": {
  "description": "If value is not present then a new value should be generated for this field",
  "default": false,
  "type": "boolean"
}

 "recipe": {"ref": "#/components/schemas/GeneratorRecipe"}

 "entropy": {
  "type": "number",
  "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
  "readOnly": true
}

 "FullItem": {
  "allOf": [
    {"ref": "#/components/schemas/Item"},
    {
      "type": "object",
      "properties": {
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {"type": "string"},
              "label": {"type": "string"}
            }
          }
        },
        "fields": {
          "type": "array",
          "items": {"ref": "#/components/schemas/Field"}
        },
        "files": {
          "type": "array",
          "items": {"ref": "#/components/schemas/File"}
        }
      }
    }
  ]
}

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

{
  "type": "object",
  "properties": {
    "sections": {
      "type": "array",
      "items": {}
    },
    "fields": {
      "type": "array",
      "items": {}
    },
    "files": {
      "type": "array",
      "items": {}
    }
  }
}

 "sections": {
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {"type": "string"},
      "label": {"type": "string"}
    }
  }
}

 "items": {
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "label": {"type": "string"}
  }
}

 "id": {"type": "string"}

 "label": {"type": "string"}

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

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

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

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

 "Vault": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}"
    },
    "name": {"type": "string"},
    "description": {"type": "string"},
    "attributeVersion": {
      "type": "integer",
      "description": "The vault version"
    },
    "contentVersion": {
      "type": "integer",
      "description": "The version of the vault contents"
    },
    "items": {
      "type": "integer",
      "description": "Number of active items in the vault"
    },
    "type": {
      "type": "string",
      "enum": [
        "PERSONAL",
        "TRANSFER",
        "USER_CREATED",
        "EVERYONE"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  }
}

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

 "name": {"type": "string"}

 "description": {"type": "string"}

 "attributeVersion": {
  "type": "integer",
  "description": "The vault version"
}

 "contentVersion": {
  "type": "integer",
  "description": "The version of the vault contents"
}

 "items": {
  "type": "integer",
  "description": "Number of active items in the vault"
}

 "type": {
  "type": "string",
  "enum": [
    "PERSONAL",
    "TRANSFER",
    "USER_CREATED",
    "EVERYONE"
  ]
}

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

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

 "ServiceDependency": {
  "type": "object",
  "description": "The state of a registered server dependency.",
  "properties": {
    "service": {"type": "string"},
    "status": {"type": "string"},
    "message": {
      "type": "string",
      "description": "Human-readable message for explaining the current state."
    }
  }
}

 "service": {"type": "string"}

 "status": {"type": "string"}

 "message": {
  "type": "string",
  "description": "Human-readable message for explaining the current state."
}

 "File": {
  "type": "object",
  "example": {
    "id": "6r65pjq33banznomn7q22sj44e",
    "name": "foo.txt",
    "size": 35,
    "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
    "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the file"
    },
    "name": {
      "type": "string",
      "description": "Name of the file"
    },
    "size": {
      "type": "integer",
      "description": "Size in bytes of the file"
    },
    "content_path": {
      "type": "string",
      "description": "Path of the Connect API that can be used to download the contents of this file.",
      "readOnly": true
    },
    "section": {
      "type": "object",
      "description": "For files that are in a section, this field describes the section.",
      "properties": {}
    },
    "content": {
      "type": "string",
      "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
    }
  }
}

 "id": {
  "type": "string",
  "description": "ID of the file"
}

 "name": {
  "type": "string",
  "description": "Name of the file"
}

 "size": {
  "type": "integer",
  "description": "Size in bytes of the file"
}

 "content_path": {
  "type": "string",
  "description": "Path of the Connect API that can be used to download the contents of this file.",
  "readOnly": true
}

 "section": {
  "type": "object",
  "description": "For files that are in a section, this field describes the section.",
  "properties": {
    "id": {"type": "string"}
  }
}

 "id": {"type": "string"}

 "content": {
  "type": "string",
  "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
}

 "Patch": {
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "path"
    ],
    "properties": {
      "op": {
        "type": "string",
        "enum": [
          "add",
          "replace",
          "remove"
        ]
      },
      "path": {
        "type": "string",
        "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
        "example": "/fields/06gnn2b95example10q91512p5/label"
      },
      "value": {"type": "object"}
    }
  }
}

 "items": {
  "type": "object",
  "required": [
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "type": "string",
      "enum": [
        "add",
        "replace",
        "remove"
      ]
    },
    "path": {
      "type": "string",
      "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
      "example": "/fields/06gnn2b95example10q91512p5/label"
    },
    "value": {"type": "object"}
  }
}