Package Classes (1.19.1)

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.

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.

AccountDefenderAssessment

Account defender risk assessment.

AccountDefenderLabel

Labels returned by account defender for this request.

Values: ACCOUNT_DEFENDER_LABEL_UNSPECIFIED (0): Default unspecified type. PROFILE_MATCH (1): The request matches a known good profile for the user. SUSPICIOUS_LOGIN_ACTIVITY (2): The request is potentially a suspicious login event and must be further verified either through multi-factor authentication or another system. SUSPICIOUS_ACCOUNT_CREATION (3): The request matched a profile that previously had suspicious account creation behavior. This can mean that this is a fake account. RELATED_ACCOUNTS_NUMBER_HIGH (4): The account in the request has a high number of related accounts. It does not necessarily imply that the account is bad but can require further investigation.

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.

Values: RESULT_UNSPECIFIED (0): No information about the latest account verification. SUCCESS_USER_VERIFIED (1): The user was successfully verified. This means the account verification challenge was successfully completed. ERROR_USER_NOT_VERIFIED (2): The user failed the verification challenge. ERROR_SITE_ONBOARDING_INCOMPLETE (3): The site is not properly onboarded to use the account verification feature. ERROR_RECIPIENT_NOT_ALLOWED (4): The recipient is not allowed for account verification. This can occur during integration but should not occur in production. ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED (5): The recipient has already been sent too many verification codes in a short amount of time. ERROR_CRITICAL_INTERNAL (6): The verification flow could not be completed due to a critical internal error. ERROR_CUSTOMER_QUOTA_EXHAUSTED (7): The client has exceeded their two factor request quota for this period of time. ERROR_VERIFICATION_BYPASSED (8): The request cannot be processed at the time because of an incident. This bypass can be restricted to a problematic destination email domain, a customer, or could affect the entire service. ERROR_VERDICT_MISMATCH (9): The request parameters do not match with the token provided and cannot be processed.

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.

Values: ANNOTATION_UNSPECIFIED (0): Default unspecified type. LEGITIMATE (1): Provides information that the event turned out to be legitimate. FRAUDULENT (2): Provides information that the event turned out to be fraudulent. PASSWORD_CORRECT (3): Provides information that the event was related to a login event in which the user typed the correct password. Deprecated, prefer indicating CORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT (4): Provides information that the event was related to a login event in which the user typed the incorrect password. Deprecated, prefer indicating INCORRECT_PASSWORD through the reasons field instead.

Reason

Enum that represents potential reasons for annotating an assessment.

Values: REASON_UNSPECIFIED (0): Default unspecified reason. CHARGEBACK (1): Indicates that the transaction had a chargeback issued with no other details. When possible, specify the type by using CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead. CHARGEBACK_FRAUD (8): Indicates that the transaction had a chargeback issued related to an alleged unauthorized transaction from the cardholder's perspective (for example, the card number was stolen). CHARGEBACK_DISPUTE (9): Indicates that the transaction had a chargeback issued related to the cardholder having provided their card details but allegedly not being satisfied with the purchase (for example, misrepresentation, attempted cancellation). REFUND (10): Indicates that the completed payment transaction was refunded by the seller. REFUND_FRAUD (11): Indicates that the completed payment transaction was determined to be fraudulent by the seller, and was cancelled and refunded as a result. TRANSACTION_ACCEPTED (12): Indicates that the payment transaction was accepted, and the user was charged. TRANSACTION_DECLINED (13): Indicates that the payment transaction was declined, for example due to invalid card details. PAYMENT_HEURISTICS (2): Indicates the transaction associated with the assessment is suspected of being fraudulent based on the payment method, billing details, shipping address or other transaction information. INITIATED_TWO_FACTOR (7): Indicates that the user was served a 2FA challenge. An old assessment with ENUM_VALUES.INITIATED_TWO_FACTOR reason that has not been overwritten with PASSED_TWO_FACTOR is treated as an abandoned 2FA flow. This is equivalent to FAILED_TWO_FACTOR. PASSED_TWO_FACTOR (3): Indicates that the user passed a 2FA challenge. FAILED_TWO_FACTOR (4): Indicates that the user failed a 2FA challenge. CORRECT_PASSWORD (5): Indicates the user provided the correct password. INCORRECT_PASSWORD (6): Indicates the user provided an incorrect password. SOCIAL_SPAM (14): Indicates that the user sent unwanted and abusive messages to other users of the platform, such as spam, scams, phishing, or social engineering.

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.

FirewallAction

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

.. _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.

Values: CARD_LABEL_UNSPECIFIED (0): No label specified. PREPAID (1): This card has been detected as prepaid. VIRTUAL (2): This card has been detected as virtual, such as a card number generated for a single transaction or merchant. UNEXPECTED_LOCATION (3): This card has been detected as being used in an unexpected geographic location.

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.

Key

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

.. _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.

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.

Values: CLASSIFICATION_REASON_UNSPECIFIED (0): Default unspecified type. AUTOMATION (1): Interactions matched the behavior of an automated agent. UNEXPECTED_ENVIRONMENT (2): The event originated from an illegitimate environment. TOO_MUCH_TRAFFIC (3): Traffic volume from the event source is higher than normal. UNEXPECTED_USAGE_PATTERNS (4): Interactions with the site were significantly different than expected patterns. LOW_CONFIDENCE_SCORE (5): Too little traffic has been received from this site thus far to generate quality risk analysis. SUSPECTED_CARDING (6): The request matches behavioral characteristics of a carding attack. SUSPECTED_CHARGEBACK (7): The request matches behavioral characteristics of chargebacks for fraud.

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.

TestingOptions

Options for user acceptance testing.

TestingChallenge

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

Values: TESTING_CHALLENGE_UNSPECIFIED (0): Perform the normal risk analysis and return either nocaptcha or a challenge depending on risk and trust factors. NOCAPTCHA (1): Challenge requests for this key always return a nocaptcha, which does not require a solution. UNSOLVABLE_CHALLENGE (2): Challenge requests for this key always return an unsolvable challenge.

TokenProperties

Properties of the provided event token.

InvalidReason

Enum that represents the types of invalid token reasons.

Values: INVALID_REASON_UNSPECIFIED (0): Default unspecified type. UNKNOWN_INVALID_REASON (1): If the failure reason was not accounted for. MALFORMED (2): The provided user verification token was malformed. EXPIRED (3): The user verification token had expired. DUPE (4): The user verification had already been seen. MISSING (5): The user verification token was not present. BROWSER_ERROR (6): A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker.

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.

Values: TRANSACTION_EVENT_TYPE_UNSPECIFIED (0): Default, unspecified event type. MERCHANT_APPROVE (1): Indicates that the transaction is approved by the merchant. The accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. MERCHANT_DENY (2): Indicates that the transaction is denied and concluded due to risks detected by the merchant. The accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'. MANUAL_REVIEW (3): Indicates that the transaction is being evaluated by a human, due to suspicion or risk. AUTHORIZATION (4): Indicates that the authorization attempt with the card issuer succeeded. AUTHORIZATION_DECLINE (5): Indicates that the authorization attempt with the card issuer failed. The accompanying reasons can include Visa's '54' indicating that the card is expired, or '82' indicating that the CVV is incorrect. PAYMENT_CAPTURE (6): Indicates that the transaction is completed because the funds were settled. PAYMENT_CAPTURE_DECLINE (7): Indicates that the transaction could not be completed because the funds were not settled. CANCEL (8): Indicates that the transaction has been canceled. Specify the reason for the cancellation. For example, 'INSUFFICIENT_INVENTORY'. CHARGEBACK_INQUIRY (9): Indicates that the merchant has received a chargeback inquiry due to fraud for the transaction, requesting additional information before a fraud chargeback is officially issued and a formal chargeback notification is sent. CHARGEBACK_ALERT (10): Indicates that the merchant has received a chargeback alert due to fraud for the transaction. The process of resolving the dispute without involving the payment network is started. FRAUD_NOTIFICATION (11): Indicates that a fraud notification is issued for the transaction, sent by the payment instrument's issuing bank because the transaction appears to be fraudulent. We recommend including TC40 or SAFE data in the reason field for this event type. For partial chargebacks, we recommend that you include an amount in the value field. CHARGEBACK (12): Indicates that the merchant is informed by the payment network that the transaction has entered the chargeback process due to fraud. Reason code examples include Discover's '6005' and '6041'. For partial chargebacks, we recommend that you include an amount in the value field. CHARGEBACK_REPRESENTMENT (13): Indicates that the transaction has entered the chargeback process due to fraud, and that the merchant has chosen to enter representment. Reason examples include Discover's '6005' and '6041'. For partial chargebacks, we recommend that you include an amount in the value field. CHARGEBACK_REVERSE (14): Indicates that the transaction has had a fraud chargeback which was illegitimate and was reversed as a result. For partial chargebacks, we recommend that you include an amount in the value field. REFUND_REQUEST (15): Indicates that the merchant has received a refund for a completed transaction. For partial refunds, we recommend that you include an amount in the value field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) REFUND_DECLINE (16): Indicates that the merchant has received a refund request for this transaction, but that they have declined it. For partial refunds, we recommend that you include an amount in the value field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) REFUND (17): Indicates that the completed transaction was refunded by the merchant. For partial refunds, we recommend that you include an amount in the value field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax) REFUND_REVERSE (18): Indicates that the completed transaction was refunded by the merchant, and that this refund was reversed. For partial refunds, we recommend that you include an amount in the value field.

UpdateFirewallPolicyRequest

The update firewall policy request message.

UpdateKeyRequest

The update key request message.

UserId

An identifier associated with a user.

.. _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-enterprise/docs/usecase#comparison_of_features.

Values: WAF_FEATURE_UNSPECIFIED (0): Undefined feature. CHALLENGE_PAGE (1): Redirects suspicious traffic to reCAPTCHA. SESSION_TOKEN (2): Use reCAPTCHA session-tokens to protect the whole user session on the site's domain. ACTION_TOKEN (3): Use reCAPTCHA action-tokens to protect user actions. EXPRESS (5): Use reCAPTCHA WAF express protection to protect any content other than web pages, like APIs and IoT devices.

WafService

Web Application Firewalls supported by reCAPTCHA Enterprise.

Values: WAF_SERVICE_UNSPECIFIED (0): Undefined WAF CA (1): Cloud Armor FASTLY (3): Fastly CLOUDFLARE (4): Cloudflare

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.

Values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED (0): Default type that indicates this enum hasn't been specified. USABILITY (1): Key tends to show fewer and easier challenges. BALANCE (2): Key tends to show balanced (in amount and difficulty) challenges. SECURITY (3): Key tends to show more and harder challenges.

IntegrationType

Enum that represents the integration types for web keys.

Values: INTEGRATION_TYPE_UNSPECIFIED (0): Default type that indicates this enum hasn't been specified. This is not a valid IntegrationType, one of the other types must be specified instead. SCORE (1): Only used to produce scores. It doesn't display the "I'm not a robot" checkbox and never shows captcha challenges. CHECKBOX (2): Displays the "I'm not a robot" checkbox and may show captcha challenges after it is checked. INVISIBLE (3): Doesn't display the "I'm not a robot" checkbox, but may show captcha challenges after risk analysis.

Modules

pagers

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