reCAPTCHA Enterprise API (recaptchaenterprise:v1)

2023-03-24

5 new methods

Additions

    Methods
  • recaptchaenterprise.projects.firewallpolicies.patch

      Flat Path: v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}

      HTTP Method: PATCH

      Path: v1/{+name}

      Parameters:

        name

          Pattern: ^projects/[^/]+/firewallpolicies/[^/]+$

          Location: path

          Description: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".

          Type: string

          Required: Yes

        updateMask

          Location: query

          Description: Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.

          Type: string

          Format: google-fieldmask

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates the specified firewall policy.

      Parameter Order: name

  • recaptchaenterprise.projects.firewallpolicies.delete

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Pattern: ^projects/[^/]+/firewallpolicies/[^/]+$

          Description: Required. The name of the policy to be deleted, in the format "projects/{project}/firewallpolicies/{firewallpolicy}".

          Type: string

          Required: Yes

          Location: path

      HTTP Method: DELETE

      Path: v1/{+name}

      Description: Deletes the specified firewall policy.

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}

  • recaptchaenterprise.projects.firewallpolicies.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        pageToken

          Location: query

          Type: string

          Description: Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.

        parent

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+$

          Location: path

          Description: Required. The name of the project to list the policies for, in the format "projects/{project}".

        pageSize

          Type: integer

          Description: Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.

          Format: int32

          Location: query

      HTTP Method: GET

      Path: v1/{+parent}/firewallpolicies

      Flat Path: v1/projects/{projectsId}/firewallpolicies

      Parameter Order: parent

  • recaptchaenterprise.projects.firewallpolicies.create

      HTTP Method: POST

      Path: v1/{+parent}/firewallpolicies

      Parameter Order: parent

      Parameters:

        parent

          Location: path

          Required: Yes

          Description: Required. The name of the project this policy will apply to, in the format "projects/{project}".

          Type: string

          Pattern: ^projects/[^/]+$

      Flat Path: v1/projects/{projectsId}/firewallpolicies

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • recaptchaenterprise.projects.firewallpolicies.get

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        name

          Type: string

          Description: Required. The name of the requested policy, in the format "projects/{project}/firewallpolicies/{firewallpolicy}".

          Required: Yes

          Pattern: ^projects/[^/]+/firewallpolicies/[^/]+$

          Location: path

      Description: Returns the specified firewall policy.

      Flat Path: v1/projects/{projectsId}/firewallpolicies/{firewallpoliciesId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+name}