google-vault

Archiving and eDiscovery for G Suite.

Authentication & Identity Management · Google Vault

Configuration parameters

  • gsuite_credentials — Username (required)
  • auth_json — Authentication file contents
  • auth_json_creds —
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (17)

  • gvault-add-heldAccount

    Adds a Held Account to a hold. This structure is immutable.

  • gvault-create-export-drive

    Creates a Google Vault export in order to perform search actions on drives.

  • gvault-create-export-groups

    Creates a Google Vault Export in order to perform search actions on Google groups.

  • gvault-create-export-mail

    Creates a Google Vault export in order to perform search actions on emails.

  • gvault-create-hold

    Creates a hold in the given matter. Holds are used to preserve data in the organization.

  • gvault-create-matter

    Creates a new matter with the specified name and description. The initial state is open, and the owner is the method caller. First, checks if a matter with the same name already exists.

  • gvault-delete-hold

    Removes a hold by ID. This will release any Held Accounts on this Hold.

  • gvault-download-results

    Downloads an export by bucket name and download ID.

  • gvault-export-status

    Gets the status of one or more specified exports.

  • gvault-get-drive-results

    Get the results of a specified drive export.

  • gvault-get-groups-results

    Get the results of a specified group export.

  • gvault-get-mail-results

    Get the results of a specified mail export.

  • gvault-get-matter

    Search for a matter by name or by ID.

  • gvault-list-holds

    Lists all holds for a specified matter.

  • gvault-list-matters

    Lists matters the user has access to.

  • gvault-matter-update-state

    Matter's updated state.

  • gvault-remove-heldAccount

    Removes a Held Account from a hold.