Google Vault
Search, export, and manage holds/exports for Vault matters
Connect Google Vault to create exports, list exports, and manage holds within matters.
Create an export in a matter
Parameter | Type | Required | Description |
---|
matterId | string | Yes | No description |
exportName | string | Yes | No description |
corpus | string | Yes | Data corpus to export (MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE) |
accountEmails | string | No | Comma-separated list of user emails to scope export |
orgUnitId | string | No | Organization unit ID to scope export (alternative to emails) |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
List exports for a matter
Parameter | Type | Required | Description |
---|
matterId | string | Yes | No description |
pageSize | number | No | No description |
pageToken | string | No | No description |
exportId | string | No | No description |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
Download a single file from a Google Vault export (GCS object)
Parameter | Type | Required | Description |
---|
matterId | string | Yes | No description |
bucketName | string | Yes | No description |
objectName | string | Yes | No description |
fileName | string | No | No description |
Parameter | Type | Description |
---|
file | file | Downloaded Vault export file stored in execution files |
Create a hold in a matter
Parameter | Type | Required | Description |
---|
matterId | string | Yes | No description |
holdName | string | Yes | No description |
corpus | string | Yes | Data corpus to hold (MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE) |
accountEmails | string | No | Comma-separated list of user emails to put on hold |
orgUnitId | string | No | Organization unit ID to put on hold (alternative to accounts) |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
List holds for a matter
Parameter | Type | Required | Description |
---|
matterId | string | Yes | No description |
pageSize | number | No | No description |
pageToken | string | No | No description |
holdId | string | No | No description |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
Create a new matter in Google Vault
Parameter | Type | Required | Description |
---|
name | string | Yes | No description |
description | string | No | No description |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
List matters, or get a specific matter if matterId is provided
Parameter | Type | Required | Description |
---|
pageSize | number | No | No description |
pageToken | string | No | No description |
matterId | string | No | No description |
Parameter | Type | Description |
---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
- Category:
tools
- Type:
google_vault