Discover the attributes that define schema properties and details of the built-in properties
Properties define the values stored in a collection's objects. These attributes describe a property:
- Name, which must be unique within the schema.
- Data type of the value.
- Options that specify whether the value is:
The storage backend database supports standard structured data. Support for file storage is on the Vault roadmap.
When Vault creates a collection, it adds built-in properties based on the schema prototype. These built-in properties are readable and are subject to the identity and access management policies in the same way that user-defined properties are. After creating a collection and adding data, read requests can include built-in properties to get the values of these properties.
These are the built-in properties:
|id||The unique identifier of an object in the collection.|
|_owner_id||The ID of the owner of the object. For associated data, this value identifies the owning object in a PERSONS collection.|
|_owner_collection||The name of the collection in which the owner of the object defined. For associated data, this value identifies the PERSONS collection containing the owner.|
|_tenant_id||The ID of the tenant with access privileges for this object. Must not be set on a 'DATA' object which has an owner. In that case the tenant is taken from the owner.|
|_creation_time||The time when the object was created.|
|_modification_time||The time when the object was most recently modified.|
|_expiration_time||The time when the object is archived.|
The names of the built-in properties are prefixed with '_'. Properties defined by the user cannot have this prefix.
The definitions of the built-in properties cannot be changed. Attempts to do so when updating a collection returns an error.
The built-in properties are returned by all the REST API operations and CLI calls that return the properties of a collection, such as add collection, get all properties, etc. Both the PVSchema and JSON formats return built-in properties.