Gcp/vault
@swamp/gcp/vaultv2026.07.21.4
01README
Google Cloud vault infrastructure models
02Release Notes
- Updated: matters_exports, matters_holds
03Models
@swamp/gcp/vault/mattersv2026.07.21.2matters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | An optional description for the matter. |
| matterId? | string | The matter ID, which is generated by the server. Leave blank when creating a matter. |
| matterPermissions? | array | Lists 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? | enum | Optional. The requested data region for the matter. |
| name? | string | The name of the matter. |
| state? | enum | The state of the matter. |
fn create()
Create a matters
fn get(identifier: string)
Get a matters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the matters |
fn update(identifier?: string)
Update matters attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific matters by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the matters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the matters |
fn sync(identifier?: string)
Sync matters state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific matters by name (e.g. one discovered by list) |
fn list(pageSize?: number, state?: string, view?: string, maxPages?: number)
List matters resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The number of matters to return in the response. Default and maximum are 100. |
| state? | string | If set, lists only matters with the specified state. The default lists matters of all states. |
| view? | string | Specifies how much information about the matter to return in response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_permissions(ccMe?: any, matterPermission?: any, sendEmails?: any)
add permissions
| Argument | Type | Description |
|---|---|---|
| ccMe? | any | |
| matterPermission? | any | |
| sendEmails? | any |
fn close()
close
fn count(query?: any, view?: any)
count
| Argument | Type | Description |
|---|---|---|
| query? | any | |
| view? | any |
fn reopen()
reopen
fn undelete()
undelete
Resources
state(infinite)— Represents a matter. To work with Vault resources, the account must have the ...
@swamp/gcp/vault/matters-exportsv2026.07.21.4matters_exports.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| exportOptions? | object | Additional export options. |
| matterId? | string | Output only. The matter ID. |
| name? | string | The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports. |
| query? | object | The query parameters used to create the export. |
fn create(waitForReady?: boolean)
Create a exports
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a exports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the exports |
fn delete(identifier: string)
Delete the exports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the exports |
fn sync(identifier?: string)
Sync exports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific exports by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List exports resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The number of exports to return in the response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An export. To work with Vault resources, the account must have the [required ...
@swamp/gcp/vault/matters-holdsv2026.07.21.4matters_holds.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| accounts? | array | If set, the hold applies to the specified accounts and **orgUnit** must be empty. |
| corpus? | enum | The service to be searched. |
| holdId? | string | The unique immutable ID of the hold. Assigned during creation. |
| name? | string | The name of the hold. |
| orgUnit? | object | If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**. |
| query? | object | Service-specific options. If set, **CorpusQuery** must match **CorpusType**. |
| updateTime? | string | The last time this hold was modified. |
| matterId | string | The matter ID. |
fn create()
Create a holds
fn get(identifier: string)
Get a holds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the holds |
fn update(identifier?: string)
Update holds attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific holds by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the holds
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the holds |
fn sync(identifier?: string)
Sync holds state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific holds by name (e.g. one discovered by list) |
fn list(pageSize?: number, view?: string, maxPages?: number)
List holds resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100. |
| view? | string | The amount of detail to return for a hold. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_held_accounts(accountIds?: any, emails?: any)
add held accounts
| Argument | Type | Description |
|---|---|---|
| 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.07.21.3matters_holds_accounts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| accountId? | string | The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |
| email? | string | The primary email address of the account. If used as an input, this takes precedence over **accountId**. |
| matterId | string | The matter ID. |
| holdId | string | The hold ID. |
fn create()
Create a accounts
fn get(identifier: string)
Get a accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn delete(identifier: string)
Delete the accounts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the accounts |
fn sync(identifier?: string)
Sync accounts state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific accounts by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List accounts resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An account covered by a hold. This structure is immutable. It can be an indiv...
@swamp/gcp/vault/matters-savedqueriesv2026.07.21.3matters_savedqueries.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| displayName? | string | The name of the saved query. |
| matterId? | string | Output 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? | object | The search parameters of the saved query. |
| savedQueryId? | string | A unique identifier for the saved query. |
fn create()
Create a savedQueries
fn get(identifier: string)
Get a savedQueries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the savedQueries |
fn delete(identifier: string)
Delete the savedQueries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the savedQueries |
fn sync(identifier?: string)
Sync savedQueries state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific savedQueries by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List savedQueries resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of saved queries to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The definition of a saved query. To work with Vault resources, the account mu...
04Previous Versions
2026.07.21.1
- Updated: matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.07.20.2
- Updated: matters_exports, matters_holds
2026.07.20.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.07.19.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.07.18.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.07.17.1
- Updated: matters, matters_exports, matters_holds
2026.06.17.1
- Updated: matters_holds
2026.06.08.2
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.06.07.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.06.01.1
- Updated: matters_exports
2026.05.25.3
- Updated: matters_holds_accounts
Modified 5 models
2026.05.24.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.05.21.2
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.04.23.1
2026.04.03.3
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
2026.04.03.1
- Updated: matters, matters_exports, matters_holds, matters_holds_accounts, matters_savedqueries
05Stats
A
100 / 100
Downloads
0
Archive size
83.4 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels