TrueVault REST API
Overview
Authentication
API Requests
API Responses
Usage Tracking (Billing)
Users API
Create a User
Read a User
List all Users
Update a User
Delete a User
Create Access Token for a User
Create API Key for a User
Create Access Key and Secret Key for a User
Start MFA Enrollment for a User
Finalize MFA Enrollment for a User
Unenroll MFA for a User
Authentication API
Login a User
Logout a User
Verify a User
Groups API
Access Grid
Specifying Ids
Ownership
Example Group Policies
Create a Group
Read a Group
List all Groups
Update a Group
Add users to a Group
Delete a Group
Vaults API
Create a Vault
Read a Vault
List all Vaults
Update a Vault
Delete a Vault
BLOBs API
Create a BLOB
Read a BLOB
List all BLOBs
Update a BLOB
Update a BLOB’s Owner
Delete a BLOB
Documents API
Create a Document
Read a Document
List all Documents
List all Documents with Schema
Update a Document
Update a Document’s Owner
Delete a Document
Reindex a Document
Schemas API
Create a Schema
Read a Schema
List all Schemas
Update a Schema
Delete a Schema
Create the User Schema
Read the User Schema
Update the User Schema
Delete the User Schema
Search API
Overview
Search Permissions
Defining Search Options
Searching TrueVault System Fields
Searching and Sorting By Geospatial Distance
Search Documents
Search Users
Email API
Email Request Format
Template Substitution
Value Specifiers
Email a user
Changelog
2017-01-26
2016-07-28
2015-12-15
2015-11-06
2015-10-30
2015-07-08
2015-07-06
2015-05-26
2015-03-27
2015-02-11
2014-12-16
2014-11-11
2014-11-05
2014-11-03
2014-10-23
TrueVault REST API
Docs
»
TrueVault Documentation
TrueVault Documentation
ΒΆ
Contents:
Overview
Authentication
Building the Auth Header
API Keys
Access Tokens
API Requests
API Responses
Sample 2xx Response
Sample 4xx Response
Usage Tracking (Billing)
Users API
Create a User
Read a User
List all Users
Update a User
Delete a User
Create Access Token for a User
Create API Key for a User
Create Access Key and Secret Key for a User
Start MFA Enrollment for a User
Finalize MFA Enrollment for a User
Unenroll MFA for a User
Authentication API
Login a User
Logout a User
Verify a User
Groups API
Access Grid
Specifying Ids
Ownership
Ownership Resource Specifiers
Changing Ownership
Searching with Ownership
Example Group Policies
Create a Group
Read a Group
List all Groups
Update a Group
Add users to a Group
Delete a Group
Vaults API
Create a Vault
Read a Vault
List all Vaults
Update a Vault
Delete a Vault
BLOBs API
Create a BLOB
Read a BLOB
List all BLOBs
Update a BLOB
Update a BLOB’s Owner
Delete a BLOB
Documents API
Create a Document
Read a Document
List all Documents
List all Documents with Schema
Update a Document
Update a Document’s Owner
Delete a Document
Reindex a Document
Schemas API
Create a Schema
Read a Schema
List all Schemas
Update a Schema
Delete a Schema
Create the User Schema
Read the User Schema
Update the User Schema
Delete the User Schema
Search API
Overview
Search Permissions
Defining Search Options
Sample search_option
Sample Search Response
Searching TrueVault System Fields
Searching and Sorting By Geospatial Distance
Example Geo Point Document Field:
Example Geo Point Schema:
Example Geo Point Search Option:
Example Geo Point Search Result:
Search Documents
Search Users
Email API
Email Request Format
Template Substitution
Value Specifiers
Email a user
Changelog
2017-01-26
2016-07-28
2015-12-15
2015-11-06
2015-10-30
2015-07-08
2015-07-06
2015-05-26
2015-03-27
2015-02-11
2014-12-16
2014-11-11
2014-11-05
2014-11-03
2014-10-23