Google Vault Tools

Google Vault is Google Workspace's eDiscovery and information-governance service. These tools let a workflow list and create matters, fetch a specific matter, and list a matter's exports through the Google Vault REST API — useful for automating legal hold, retention, and export tracking flows.

Overview

Operations

Configuration

All operations authenticate with a Google OAuth access token passed as the accessToken parameter. It is a secret (marked password/user-only) and is sent in the request as Authorization: Bearer <accessToken>. The token must be authorized for the Google Vault API scope.

google_vault_list_matters

google_vault_get_matter

google_vault_create_matter

google_vault_list_exports

Outputs

google_vault_list_matters

• data (json) — Array of matter objects.
• metadata (json) — List metadata. Contains nextPageToken (string) — token for the next page of results.

google_vault_get_matter

• data (json) — The matter object.
• metadata (json) — Response metadata.

google_vault_create_matter

• data (json) — The created matter object.
• metadata (json) — Response metadata.

google_vault_list_exports

• data (json) — Array of export objects.
• metadata (json) — List metadata. Contains nextPageToken (string) — token for the next page of results.

YAML Example

google_vault_1:
  type: google_vault
  name: "Google Vault"
  inputs:
    operation: "google_vault_list_matters"
    pageSize: 50
    accessToken: "{{GOOGLE_VAULT_ACCESS_TOKEN}}"
  connections:
    outgoing:
      - target: next-block-id

A create-matter example:

google_vault_create_1:
  type: google_vault
  name: "Google Vault"
  inputs:
    operation: "google_vault_create_matter"
    name: "Q3 Litigation Hold"
    description: "Matter for the Q3 legal review"
    accessToken: "{{GOOGLE_VAULT_ACCESS_TOKEN}}"
  connections:
    outgoing:
      - target: next-block-id

Tips

• Auth setup: Provide a Google OAuth 2.0 access token authorized for the Google Vault API (https://www.googleapis.com/auth/ediscovery). The token is sent as a Bearer token; supply it via an environment variable reference like {{GOOGLE_VAULT_ACCESS_TOKEN}} rather than hardcoding it.
• Matter IDs: google_vault_get_matter and google_vault_list_exports both require a matterId. Run google_vault_list_matters first and read the IDs from its data array — reference them downstream with {{google_vault_1.data}}.
• Pagination: List operations return a metadata.nextPageToken; use pageSize to control page length and follow the token (e.g. {{google_vault_1.metadata}}) to page through large result sets.
• Order of operations: Vault requires a matter to exist before you can export from it — create or look up the matter first, then list its exports.