Package Classes (1.25.0)

Service to determine the likelihood an event is legitimate.

Service to determine the likelihood an event is legitimate.

A pager for iterating through list_firewall_policies requests.

This class thinly wraps an initial ListFirewallPoliciesResponse object, and provides an __aiter__ method to iterate through its firewall_policies field.

If there are more pages, the __aiter__ method will make additional ListFirewallPolicies requests and continue to iterate through the firewall_policies field on the corresponding responses.

All the usual ListFirewallPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_firewall_policies requests.

This class thinly wraps an initial ListFirewallPoliciesResponse object, and provides an __iter__ method to iterate through its firewall_policies field.

If there are more pages, the __iter__ method will make additional ListFirewallPolicies requests and continue to iterate through the firewall_policies field on the corresponding responses.

All the usual ListFirewallPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_ip_overrides requests.

This class thinly wraps an initial ListIpOverridesResponse object, and provides an __aiter__ method to iterate through its ip_overrides field.

If there are more pages, the __aiter__ method will make additional ListIpOverrides requests and continue to iterate through the ip_overrides field on the corresponding responses.

All the usual ListIpOverridesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_ip_overrides requests.

This class thinly wraps an initial ListIpOverridesResponse object, and provides an __iter__ method to iterate through its ip_overrides field.

If there are more pages, the __iter__ method will make additional ListIpOverrides requests and continue to iterate through the ip_overrides field on the corresponding responses.

All the usual ListIpOverridesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_keys requests.

This class thinly wraps an initial ListKeysResponse object, and provides an __aiter__ method to iterate through its keys field.

If there are more pages, the __aiter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_keys requests.

This class thinly wraps an initial ListKeysResponse object, and provides an __iter__ method to iterate through its keys field.

If there are more pages, the __iter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_related_account_group_memberships requests.

This class thinly wraps an initial ListRelatedAccountGroupMembershipsResponse object, and provides an __aiter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __aiter__ method will make additional ListRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual ListRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_related_account_group_memberships requests.

This class thinly wraps an initial ListRelatedAccountGroupMembershipsResponse object, and provides an __iter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __iter__ method will make additional ListRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual ListRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_related_account_groups requests.

This class thinly wraps an initial ListRelatedAccountGroupsResponse object, and provides an __aiter__ method to iterate through its related_account_groups field.

If there are more pages, the __aiter__ method will make additional ListRelatedAccountGroups requests and continue to iterate through the related_account_groups field on the corresponding responses.

All the usual ListRelatedAccountGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_related_account_groups requests.

This class thinly wraps an initial ListRelatedAccountGroupsResponse object, and provides an __iter__ method to iterate through its related_account_groups field.

If there are more pages, the __iter__ method will make additional ListRelatedAccountGroups requests and continue to iterate through the related_account_groups field on the corresponding responses.

All the usual ListRelatedAccountGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_related_account_group_memberships requests.

This class thinly wraps an initial SearchRelatedAccountGroupMembershipsResponse object, and provides an __aiter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __aiter__ method will make additional SearchRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual SearchRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_related_account_group_memberships requests.

This class thinly wraps an initial SearchRelatedAccountGroupMembershipsResponse object, and provides an __iter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __iter__ method will make additional SearchRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual SearchRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Account defender risk assessment.

Labels returned by account defender for this request.

Information about account verification, used for identity verification.

Result of the account verification as contained in the verdict token issued at the end of the verification flow.

The AddIpOverride request message.

Response for AddIpOverride.

Settings specific to keys that can be used by Android apps.

The request message to annotate an Assessment.

Enum that represents the types of annotations.

Enum that represents potential reasons for annotating an assessment.

Empty response for AnnotateAssessment.

Contains fields that are required to perform Apple-specific integrity checks.

A reCAPTCHA Enterprise assessment resource.

The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user.

Metrics related to challenges.

The create assessment request message.

The create firewall policy request message.

The create key request message.

The delete firewall policy request message.

The delete key request message.

Information about a verification endpoint that can be used for 2FA.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The event being assessed.

Setting that controls Fraud Prevention assessments.

Settings specific to keys that can be used for reCAPTCHA Express.

An individual action. Each action represents what to do if a policy matches.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

An allow action continues processing a request unimpeded.

A block action serves an HTTP error code a prevents the request from hitting the backend.

An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests.

A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token.

A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend.

A substitute action transparently serves a different page than the one requested.

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Policy config assessment.

Assessment for Fraud Prevention.

Information about behavioral trust of the transaction.

Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.

Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.

Fraud signals describing users and cards involved in the transaction.

Signals describing the payment card used in this transaction.

Risk labels describing the card being assessed, such as its funding mechanism.

Signals describing the user involved in this transaction.

The get firewall policy request message.

The get key request message.

The get metrics request message.

Settings specific to keys that can be used by iOS apps.

Information about the IP or IP range override.

Enum that represents the type of IP override.

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

The list firewall policies request message.

Response to request to list firewall policies belonging to a project.

The ListIpOverrides request message.

Response for ListIpOverrides.

The list keys request message.

Response to request to list keys in a project.

The request message to list memberships in a related account group.

The response to a ListRelatedAccountGroupMemberships call.

The request message to list related account groups.

The response to a ListRelatedAccountGroups call.

Metrics for a single Key.

The migrate key request message.

Assessment for Phone Fraud

Private password leak verification info.

A group of related accounts.

A membership in a group of related accounts.

The removeIpOverride request message.

Response for RemoveIpOverride.

The reorder firewall policies request message.

The reorder firewall policies response message.

The retrieve legacy secret key request message.

Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.

Risk analysis result for an event.

Challenge information for SCORE_AND_CHALLENGE keys

Reasons contributing to the risk analysis verdict.

Score distribution.

The abstract base class for a message.

Metrics related to scoring.

The abstract base class for a message.

The request message to search related account group memberships.

The response to a SearchRelatedAccountGroupMemberships call.

Information about SMS toll fraud.

Reasons contributing to the SMS toll fraud verdict.

Options for user acceptance testing.

Enum that represents the challenge option for challenge-based (CHECKBOX, INVISIBLE) testing keys.

Properties of the provided event token.

Enum that represents the types of invalid token reasons.

Transaction data associated with a payment protected by reCAPTCHA Enterprise.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Structured address format for billing and shipping addresses.

Details about the transaction from the gateway.

Line items being purchased in this transaction.

Details about a user's account involved in the transaction.

Describes an event in the lifecycle of a payment transaction.

Enum that represents an event in the payment transaction lifecycle.

The update firewall policy request message.

The update key request message.

An identifier associated with a user.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

User information associated with a request protected by reCAPTCHA Enterprise.

Settings specific to keys that can be used for WAF (Web Application Firewall).

Supported WAF features. For more information, see https://cloud.google.com/recaptcha/docs/usecase#comparison_of_features.

Web Application Firewalls supported by reCAPTCHA.

Settings specific to keys that can be used by websites.

Enum that represents the possible challenge frequency and difficulty configurations for a web key.

Enum that represents the integration types for web keys.

API documentation for recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers module.