Skip to main content
← back to extensions

@swamp/gcp/vault

v2026.04.23.1

Google Cloud vault infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

gcpgoogle-cloudvaultcloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/vault

@swamp/gcp/vault/mattersv2026.04.23.1matters.ts

Global Arguments

ArgumentTypeDescription
description?stringAn optional description for the matter.
matterId?stringThe matter ID, which is generated by the server. Leave blank when creating a matter.
matterPermissions?arrayLists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
matterRegion?enumOptional. The requested data region for the matter.
name?stringThe name of the matter.
state?enumThe state of the matter.
createCreate a matters
getGet a matters
ArgumentTypeDescription
identifierstringThe name of the matters
updateUpdate matters attributes
deleteDelete the matters
ArgumentTypeDescription
identifierstringThe name of the matters
syncSync matters state from GCP
add_permissionsadd permissions
ArgumentTypeDescription
ccMe?any
matterPermission?any
sendEmails?any
closeclose
countcount
ArgumentTypeDescription
query?any
view?any
reopenreopen
undeleteundelete

Resources

state(infinite)— Represents a matter. To work with Vault resources, the account must have the ...
@swamp/gcp/vault/matters-exportsv2026.04.23.1matters_exports.ts

Global Arguments

ArgumentTypeDescription
cloudStorageSink?objectExport sink for Cloud Storage files.
exportOptions?objectAdditional options for exports
matterId?stringOutput only. The matter ID.
name?stringThe export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports.
query?objectThe query definition used for search and export.
requester?objectUser's information.
stats?objectProgress information for an export.
createCreate a exports
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a exports
ArgumentTypeDescription
identifierstringThe name of the exports
deleteDelete the exports
ArgumentTypeDescription
identifierstringThe name of the exports
syncSync exports state from GCP

Resources

state(infinite)— An export. To work with Vault resources, the account must have the [required ...
@swamp/gcp/vault/matters-holdsv2026.04.23.1matters_holds.ts

Global Arguments

ArgumentTypeDescription
accounts?arrayIf set, the hold applies to the specified accounts and **orgUnit** must be empty.
corpus?enumThe service to be searched.
holdId?stringThe unique immutable ID of the hold. Assigned during creation.
name?stringThe name of the hold.
orgUnit?objectThe organizational unit covered by a hold. This structure is immutable.
query?objectService-specific options for holds.
updateTime?stringThe last time this hold was modified.
matterIdstringThe matter ID.
createCreate a holds
getGet a holds
ArgumentTypeDescription
identifierstringThe name of the holds
updateUpdate holds attributes
deleteDelete the holds
ArgumentTypeDescription
identifierstringThe name of the holds
syncSync holds state from GCP
add_held_accountsadd held accounts
ArgumentTypeDescription
accountIds?any
emails?any

Resources

state(infinite)— A hold. A hold prevents the specified Google Workspace service from purging d...
@swamp/gcp/vault/matters-holds-accountsv2026.04.23.1matters_holds_accounts.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accountId?stringThe account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
email?stringThe primary email address of the account. If used as an input, this takes precedence over **accountId**.
matterIdstringThe matter ID.
holdIdstringThe hold ID.
createCreate a accounts
getGet a accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
deleteDelete the accounts
ArgumentTypeDescription
identifierstringThe name of the accounts
syncSync accounts state from GCP

Resources

state(infinite)— An account covered by a hold. This structure is immutable. It can be an indiv...
@swamp/gcp/vault/matters-savedqueriesv2026.04.23.1matters_savedqueries.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
displayName?stringThe name of the saved query.
matterId?stringOutput only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.
query?objectThe query definition used for search and export.
savedQueryId?stringA unique identifier for the saved query.
createCreate a savedQueries
getGet a savedQueries
ArgumentTypeDescription
identifierstringThe name of the savedQueries
deleteDelete the savedQueries
ArgumentTypeDescription
identifierstringThe name of the savedQueries
syncSync savedQueries state from GCP

Resources

state(infinite)— The definition of a saved query. To work with Vault resources, the account mu...