firewallpolicies

Creates, updates, deletes, gets or lists a firewallpolicies resource.

Overview

Name	firewallpolicies
Type	Resource
Id	google.recaptchaenterprise.firewallpolicies

Fields

Name	Datatype	Description
name	string	Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.
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.
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 and its language definition. A condition has a max length of 500 characters.
path	string	Optional. The 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

Name	Accessible by	Required Params	Description
get	SELECT	firewallpoliciesId, projectsId	Returns the specified firewall policy.
list	SELECT	projectsId	Returns the list of all firewall policies that belong to a project.
create	INSERT	projectsId	Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.
delete	DELETE	firewallpoliciesId, projectsId	Deletes the specified firewall policy.
patch	UPDATE	firewallpoliciesId, projectsId	Updates the specified firewall policy.
reorder	EXEC	projectsId	Reorders all firewall policies.

SELECT examples

Returns the list of all firewall policies that belong to a project.

SELECT
name,
description,
actions,
condition,
path
FROM google.recaptchaenterprise.firewallpolicies
WHERE projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new firewallpolicies resource.

All Properties

/*+ create */
INSERT INTO google.recaptchaenterprise.firewallpolicies (
projectsId,
description,
actions,
path,
condition,
name
)
SELECT 
'{{ projectsId }}',
'{{ description }}',
'{{ actions }}',
'{{ path }}',
'{{ condition }}',
'{{ name }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: description
      value: string
    - name: actions
      value:
        - - name: allow
            value: []
          - name: substitute
            value:
              - name: path
                value: string
          - name: setHeader
            value:
              - name: value
                value: string
              - name: key
                value: string
          - name: includeRecaptchaScript
            value: []
          - name: block
            value: []
          - name: redirect
            value: []
    - name: path
      value: string
    - name: condition
      value: string
    - name: name
      value: string

UPDATE example

Updates a firewallpolicies resource.

/*+ update */
UPDATE google.recaptchaenterprise.firewallpolicies
SET 
description = '{{ description }}',
actions = '{{ actions }}',
path = '{{ path }}',
condition = '{{ condition }}',
name = '{{ name }}'
WHERE 
firewallpoliciesId = '{{ firewallpoliciesId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified firewallpolicies resource.

/*+ delete */
DELETE FROM google.recaptchaenterprise.firewallpolicies
WHERE firewallpoliciesId = '{{ firewallpoliciesId }}'
AND projectsId = '{{ projectsId }}';