Gcp/beyondcorp
@swamp/gcp/beyondcorpv2026.10.23.1
01README
Google Cloud beyondcorp infrastructure models
02Release Notes
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
03Behaviors
@swamp/gcp/beyondcorp/appconnectionsv2026.10.23.1appconnections.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a appConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appConnections |
fn delete(identifier: string)
Delete the appConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appConnections |
fn sync(identifier?: string)
Sync appConnections state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific appConnections by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List appConnections resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter specifying constraints of a list operation. |
| orderBy? | string | Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn resolve(appConnectorId?: any, pageSize?: any, pageToken?: any)
resolve
| Argument | Type | Description |
|---|---|---|
| appConnectorId? | any | |
| pageSize? | any | |
| pageToken? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConn...
@swamp/gcp/beyondcorp/appconnectorsv2026.10.23.1appconnectors.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a appConnectors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appConnectors |
fn delete(identifier: string)
Delete the appConnectors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appConnectors |
fn sync(identifier?: string)
Sync appConnectors state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific appConnectors by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List appConnectors resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter specifying constraints of a list operation. |
| orderBy? | string | Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn resolve_instance_config()
resolve instance config
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A BeyondCorp connector resource that represents an application facing compone...
@swamp/gcp/beyondcorp/appgatewaysv2026.10.23.1appgateways.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a appGateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appGateways |
fn delete(identifier: string)
Delete the appGateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the appGateways |
fn sync(identifier?: string)
Sync appGateways state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific appGateways by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List appGateways resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter specifying constraints of a list operation. |
| orderBy? | string | Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway...
@swamp/gcp/beyondcorp/locationsv2026.10.23.1locations.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/beyondcorp/securitygatewaysv2026.10.23.1securitygateways.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| displayName? | string | Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. |
| hubs? | record | Optional. Map of Hubs that represents regional data path deployment with GCP region as a key. |
| logging? | object | Optional. Configuration for Cloud Logging. If this field is present, the logging will be enabled. |
| name? | string | Identifier. Name of the resource. |
| proxyProtocolConfig? | object | Optional. Shared proxy configuration for all apps. |
| serviceDiscovery? | object | Optional. Settings related to the Service Discovery. |
| requestId? | string | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. |
| securityGatewayId? | string | Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a securityGateways
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a securityGateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the securityGateways |
fn update(identifier?: string, waitForReady?: boolean)
Update securityGateways attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific securityGateways by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the securityGateways
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the securityGateways |
fn sync(identifier?: string)
Sync securityGateways state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific securityGateways by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List securityGateways resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. |
| orderBy? | string | Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— The information about a security gateway resource.
@swamp/gcp/beyondcorp/securitygateways-applicationsv2026.10.23.1securitygateways_applications.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. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| displayName? | string | Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. |
| endpointMatchers? | array | Optional. An array of conditions to match the application\ |
| name? | string | Identifier. Name of the resource. |
| schema? | enum | Optional. Type of the external application. |
| upstreams? | array | Optional. Which upstream resources to forward traffic to. |
| applicationId? | string | Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. |
| requestId? | string | Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a applications
fn get(identifier: string)
Get a applications
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the applications |
fn update(identifier?: string)
Update applications attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific applications by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the applications
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the applications |
fn sync(identifier?: string)
Sync applications state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific applications by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List applications resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName "test-application" For more information, please refer to https://google.aip.dev/160. |
| orderBy? | string | Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. |
| pageSize? | number | Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any | |
| updateMask? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— The information about an application resource.
04Previous Versions
2026.10.22.1AGPL-3.0-or-later(was none)
- Updated: appconnections, appconnectors, appgateways
Modified 3 behaviors
2026.10.13.1
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.09.07.2
- Updated: appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.08.12.2
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.31.1
- Updated: securitygateways, securitygateways_applications
2026.07.29.1
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.21.3
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.21.1
- Updated: appconnections, appconnectors, securitygateways, securitygateways_applications
2026.07.20.2
- Updated: locations, appconnections, appconnectors, securitygateways, securitygateways_applications
2026.07.20.1
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.18.2
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.17.2
- Updated: appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.07.17.1
- Updated: appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.06.08.2
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.06.07.1
- Updated: locations, appconnections, appconnectors, appgateways, securitygateways, securitygateways_applications
2026.05.27.1
- Updated: appconnectors
2026.05.26.1
- Updated: locations, appconnections, appconnectors, securitygateways, securitygateways_applications
05Stats
A
100 / 100
Downloads
25
Archive size
69.2 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
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels