Package Classes (1.22.0)

Summary of entries of Classes for recaptchaenterprise.

Classes

RecaptchaEnterpriseServiceAsyncClient

Service to determine the likelihood an event is legitimate.

RecaptchaEnterpriseServiceClient

Service to determine the likelihood an event is legitimate.

ListFirewallPoliciesAsyncPager

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.

ListFirewallPoliciesPager

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.

ListKeysAsyncPager

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.

ListKeysPager

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.

ListRelatedAccountGroupMembershipsAsyncPager

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.

ListRelatedAccountGroupMembershipsPager

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.

ListRelatedAccountGroupsAsyncPager

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.

ListRelatedAccountGroupsPager

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.

SearchRelatedAccountGroupMembershipsAsyncPager

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.

SearchRelatedAccountGroupMembershipsPager

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.

AccountDefenderAssessment

Account defender risk assessment.

AccountDefenderLabel

Labels returned by account defender for this request.

AccountVerificationInfo

Information about account verification, used for identity verification.

Result

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

AddIpOverrideRequest

The AddIpOverride request message.

AddIpOverrideResponse

Response for AddIpOverride.

AndroidKeySettings

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

AnnotateAssessmentRequest

The request message to annotate an Assessment.

Annotation

Enum that represents the types of annotations.

Reason

Enum that represents potential reasons for annotating an assessment.

AnnotateAssessmentResponse

Empty response for AnnotateAssessment.

AppleDeveloperId

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

Assessment

A reCAPTCHA Enterprise assessment resource.

ChallengeMetrics

Metrics related to challenges.

CreateAssessmentRequest

The create assessment request message.

CreateFirewallPolicyRequest

The create firewall policy request message.

CreateKeyRequest

The create key request message.

DeleteFirewallPolicyRequest

The delete firewall policy request message.

DeleteKeyRequest

The delete key request message.

EndpointVerificationInfo

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

Event

The event being assessed.

FraudPrevention

Setting that controls Fraud Prevention assessments.

ExpressKeySettings

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

FirewallAction

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

AllowAction

An allow action continues processing a request unimpeded.

BlockAction

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

IncludeRecaptchaScriptAction

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.

RedirectAction

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

SetHeaderAction

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.

SubstituteAction

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

FirewallPolicy

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

FirewallPolicyAssessment

Policy config assessment.

FraudPreventionAssessment

Assessment for Fraud Prevention.

BehavioralTrustVerdict

Information about behavioral trust of the transaction.

CardTestingVerdict

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

StolenInstrumentVerdict

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

FraudSignals

Fraud signals describing users and cards involved in the transaction.

CardSignals

Signals describing the payment card used in this transaction.

CardLabel

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

UserSignals

Signals describing the user involved in this transaction.

GetFirewallPolicyRequest

The get firewall policy request message.

GetKeyRequest

The get key request message.

GetMetricsRequest

The get metrics request message.

IOSKeySettings

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

IpOverrideData

Information about the IP or IP range override.

OverrideType

Enum that represents the type of IP override.

Key

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

LabelsEntry

The abstract base class for a message.

ListFirewallPoliciesRequest

The list firewall policies request message.

ListFirewallPoliciesResponse

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

ListKeysRequest

The list keys request message.

ListKeysResponse

Response to request to list keys in a project.

ListRelatedAccountGroupMembershipsRequest

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

ListRelatedAccountGroupMembershipsResponse

The response to a ListRelatedAccountGroupMemberships call.

ListRelatedAccountGroupsRequest

The request message to list related account groups.

ListRelatedAccountGroupsResponse

The response to a ListRelatedAccountGroups call.

Metrics

Metrics for a single Key.

MigrateKeyRequest

The migrate key request message.

PhoneFraudAssessment

Assessment for Phone Fraud

PrivatePasswordLeakVerification

Private password leak verification info.

RelatedAccountGroup

A group of related accounts.

RelatedAccountGroupMembership

A membership in a group of related accounts.

ReorderFirewallPoliciesRequest

The reorder firewall policies request message.

ReorderFirewallPoliciesResponse

The reorder firewall policies response message.

RetrieveLegacySecretKeyRequest

The retrieve legacy secret key request message.

RetrieveLegacySecretKeyResponse

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

RiskAnalysis

Risk analysis result for an event.

ClassificationReason

Reasons contributing to the risk analysis verdict.

ScoreDistribution

Score distribution.

ScoreBucketsEntry

The abstract base class for a message.

ScoreMetrics

Metrics related to scoring.

ActionMetricsEntry

The abstract base class for a message.

SearchRelatedAccountGroupMembershipsRequest

The request message to search related account group memberships.

SearchRelatedAccountGroupMembershipsResponse

The response to a SearchRelatedAccountGroupMemberships call.

SmsTollFraudVerdict

Information about SMS toll fraud.

SmsTollFraudReason

Reasons contributing to the SMS toll fraud verdict.

TestingOptions

Options for user acceptance testing.

TestingChallenge

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

TokenProperties

Properties of the provided event token.

InvalidReason

Enum that represents the types of invalid token reasons.

TransactionData

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

Address

Structured address format for billing and shipping addresses.

GatewayInfo

Details about the transaction from the gateway.

Item

Line items being purchased in this transaction.

User

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

TransactionEvent

Describes an event in the lifecycle of a payment transaction.

TransactionEventType

Enum that represents an event in the payment transaction lifecycle.

UpdateFirewallPolicyRequest

The update firewall policy request message.

UpdateKeyRequest

The update key request message.

UserId

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

UserInfo

User information associated with a request protected by reCAPTCHA Enterprise.

WafSettings

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

WafFeature

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

WafService

Web Application Firewalls supported by reCAPTCHA Enterprise.

WebKeySettings

Settings specific to keys that can be used by websites.

ChallengeSecurityPreference

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

IntegrationType

Enum that represents the integration types for web keys.

Modules

pagers

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