Usage Instructions
Connect Google Vault to create exports, list exports, and manage holds within matters.
Tools
google_vault_create_matters_export
Create an export in a matter
Input
| 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) |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
google_vault_list_matters_export
List exports for a matter
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
matterId | string | Yes | No description |
pageSize | number | No | No description |
pageToken | string | No | No description |
exportId | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
google_vault_download_export_file
Download a single file from a Google Vault export (GCS object)
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
matterId | string | Yes | No description |
bucketName | string | Yes | No description |
objectName | string | Yes | No description |
fileName | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
file | file | Downloaded Vault export file stored in execution files |
google_vault_create_matters_holds
Create a hold in a matter
Input
| 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) |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
google_vault_list_matters_holds
List holds for a matter
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
matterId | string | Yes | No description |
pageSize | number | No | No description |
pageToken | string | No | No description |
holdId | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
google_vault_create_matters
Create a new matter in Google Vault
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | No description |
description | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
google_vault_list_matters
List matters, or get a specific matter if matterId is provided
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | No description |
pageToken | string | No | No description |
matterId | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
output | json | Vault API response data |
file | json | Downloaded export file (UserFile) from execution files |
Notes
- Category:
tools - Type:
google_vault