Gcp/recaptchaenterprise
@swamp/gcp/recaptchaenterprisev2026.07.21.4
01README
Google Cloud recaptchaenterprise infrastructure models
02Release Notes
- Updated: keys
03Models
@swamp/gcp/recaptchaenterprise/firewallpoliciesv2026.07.21.3firewallpolicies.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. |
| actions? | array | Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions. |
| condition? | string | Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/mast |
| description? | string | Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters. |
| name? | string | Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. |
| path? | string | Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a firewallpolicies
fn get(identifier: string)
Get a firewallpolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the firewallpolicies |
fn update(identifier?: string)
Update firewallpolicies attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific firewallpolicies by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the firewallpolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the firewallpolicies |
fn sync(identifier?: string)
Sync firewallpolicies state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific firewallpolicies by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List firewallpolicies resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of policies to return. Default is 10. Max limit is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn reorder(names?: any)
reorder
| Argument | Type | Description |
|---|---|---|
| names? | any |
Resources
state(infinite)— A FirewallPolicy represents a single matching pattern and resulting actions t...
@swamp/gcp/recaptchaenterprise/keysv2026.07.21.4keys.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. |
| androidSettings? | object | Settings for keys that can be used by Android apps. |
| displayName? | string | Required. Human-readable display name of this key. Modifiable by user. |
| expressSettings? | object | Settings for keys that can be used by reCAPTCHA Express. |
| iosSettings? | object | Settings for keys that can be used by iOS apps. |
| labels? | record | Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). |
| name? | string | Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. |
| testingOptions? | object | Optional. Options for user acceptance testing. |
| universalSettings? | object | Settings for keys that are configured through their Policy. |
| wafSettings? | object | Optional. Settings for Web Application Firewall (WAF). |
| webSettings? | object | Settings for keys that can be used by websites. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a keys
fn get(identifier: string)
Get a keys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keys |
fn update(identifier?: string)
Update keys attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keys by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the keys
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the keys |
fn sync(identifier?: string)
Sync keys state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific keys by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List keys resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of keys to return. Default is 10. Max limit is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_ip_override(ipOverrideData?: any)
add ip override
| Argument | Type | Description |
|---|---|---|
| ipOverrideData? | any |
fn get_metrics()
get metrics
fn get_policy()
get policy
fn list_ip_overrides()
list ip overrides
fn migrate(skipBillingCheck?: any)
migrate
| Argument | Type | Description |
|---|---|---|
| skipBillingCheck? | any |
fn retrieve_legacy_secret_key()
retrieve legacy secret key
fn update_policy(challengeRuleGroups?: any, clientSettings?: any, name?: any)
update policy
| Argument | Type | Description |
|---|---|---|
| challengeRuleGroups? | any | |
| clientSettings? | any | |
| name? | any |
Resources
state(infinite)— A key used to identify and configure applications (web and/or mobile) that us...
@swamp/gcp/recaptchaenterprise/relatedaccountgroupsv2026.07.21.2relatedaccountgroups.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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a relatedaccountgroups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the relatedaccountgroups |
fn sync(identifier?: string)
Sync relatedaccountgroups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific relatedaccountgroups by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List relatedaccountgroups resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A group of related accounts.
@swamp/gcp/recaptchaenterprise/relatedaccountgroups-membershipsv2026.07.21.2relatedaccountgroups_memberships.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. |
| 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 get(identifier: string)
Get a memberships
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the memberships |
fn sync(identifier?: string)
Sync memberships state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific memberships by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List memberships resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A membership in a group of related accounts.
04Previous Versions
2026.07.21.1
- Updated: firewallpolicies, keys
2026.07.20.2
- Updated: keys
Modified 1 models
2026.07.20.1
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
Modified 1 models
2026.07.19.1
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.07.18.2
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.07.17.2
- Updated: firewallpolicies, keys
2026.07.17.1
- Updated: firewallpolicies, keys, relatedaccountgroups_memberships
2026.07.16.1
- Updated: keys
Modified 1 models
2026.06.08.2
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.06.07.1
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.05.25.1
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
Modified 4 models
2026.05.24.1
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.05.21.2
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.05.18.1
2026.04.23.1
2026.04.03.3
- Updated: firewallpolicies, keys, relatedaccountgroups, relatedaccountgroups_memberships
05Stats
A
100 / 100
Downloads
0
Archive size
53.9 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