firewallpolicies

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

Overview

Name	firewallpolicies
Type	Resource
Id	google.recaptchaenterprise.firewallpolicies

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.
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.
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.
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.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.
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.
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.
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, firewallpoliciesId		Returns the specified firewall policy.
list	select	projectsId	pageSize, pageToken	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.
patch	update	projectsId, firewallpoliciesId	updateMask	Updates the specified firewall policy.
delete	delete	projectsId, firewallpoliciesId		Deletes the specified firewall policy.
reorder	exec	projectsId		Reorders all firewall policies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
firewallpoliciesId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Returns the specified firewall policy.

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

list

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

SELECT
name,
actions,
condition,
description,
path
FROM google.recaptchaenterprise.firewallpolicies
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

INSERT INTO google.recaptchaenterprise.firewallpolicies (
data__name,
data__description,
data__path,
data__condition,
data__actions,
projectsId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ path }}',
'{{ condition }}',
'{{ actions }}',
'{{ projectsId }}'
RETURNING
name,
actions,
condition,
description,
path
;

Manifest

# Description fields are for documentation purposes
- name: firewallpolicies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the firewallpolicies resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
        
    - name: description
      value: string
      description: >
        Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
        
    - name: path
      value: string
      description: >
        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.
        
    - name: condition
      value: string
      description: >
        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/master/doc/langdef.md). A condition has a max length of 500 characters.
        
    - name: actions
      value: array
      description: >
        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.
        

UPDATE examples

patch

Updates the specified firewall policy.

UPDATE google.recaptchaenterprise.firewallpolicies
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__path = '{{ path }}',
data__condition = '{{ condition }}',
data__actions = '{{ actions }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND firewallpoliciesId = '{{ firewallpoliciesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
actions,
condition,
description,
path;

DELETE examples

delete

Deletes the specified firewall policy.

DELETE FROM google.recaptchaenterprise.firewallpolicies
WHERE projectsId = '{{ projectsId }}' --required
AND firewallpoliciesId = '{{ firewallpoliciesId }}' --required;

Lifecycle Methods

reorder

Reorders all firewall policies.

EXEC google.recaptchaenterprise.firewallpolicies.reorder 
@projectsId='{{ projectsId }}' --required 
@@json=
'{
"names": "{{ names }}"
}';