Skip to main content

firewallpolicies

Overview

Namefirewallpolicies
TypeResource
Idgoogle.recaptchaenterprise.firewallpolicies

Fields

NameDatatypeDescription
namestringThe resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
descriptionstringA description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
actionsarrayThe 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.
conditionstringA 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 and its language definition. A condition has a max length of 500 characters.
pathstringThe path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

Methods

NameAccessible byRequired ParamsDescription
getSELECTfirewallpoliciesId, projectsIdReturns the specified firewall policy.
listSELECTprojectsIdReturns the list of all firewall policies that belong to a project.
createINSERTprojectsIdCreates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.
deleteDELETEfirewallpoliciesId, projectsIdDeletes the specified firewall policy.
_listEXECprojectsIdReturns the list of all firewall policies that belong to a project.
patchEXECfirewallpoliciesId, projectsIdUpdates the specified firewall policy.