As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Recaptchaenterprise v1 API¶

class google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Account defender risk assessment.

labels¶

Output only. Labels for this request.

Type: MutableSequence[google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment.AccountDefenderLabel]

class AccountDefenderLabel(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Information about account verification, used for identity verification.

endpoints¶

Optional. Endpoints that can be used for identity verification.

Type: MutableSequence[google.cloud.recaptchaenterprise_v1.types.EndpointVerificationInfo]

language_code¶

Optional. Language code preference for the verification message, set as a IETF BCP 47 language code.

Type: str

latest_verification_result¶

Output only. Result of the latest account verification challenge.

Type: google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo.Result

username¶

Username of the account that is being verified. Deprecated. Customers should now provide the account_id field in event.user_info.

Type: str

class Result(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.recaptchaenterprise_v1.types.AddIpOverrideRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The AddIpOverride request message.

name¶

Required. The name of the key to which the IP override is added, in the format projects/{project}/keys/{key}.

Type: str

ip_override_data¶

Required. IP override added to the key.

Type: google.cloud.recaptchaenterprise_v1.types.IpOverrideData

class google.cloud.recaptchaenterprise_v1.types.AddIpOverrideResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Response for AddIpOverride.

class google.cloud.recaptchaenterprise_v1.types.AndroidKeySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

allow_all_package_names¶

Optional. If set to true, allowed_package_names are not enforced.

Type: bool

allowed_package_names¶

Optional. Android package names of apps allowed to use the key. Example: ‘com.companyname.appname’

Type: MutableSequence[str]

support_non_google_app_store_distribution¶

Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.

Type: bool

class google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request message to annotate an Assessment.

name¶

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Type: str

annotation¶

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Type: google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation

reasons¶

Optional. Reasons for the annotation that are assigned to the event.

Type: MutableSequence[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Reason]

account_id¶

Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Type: str

hashed_account_id¶

Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Type: bytes

transaction_event¶

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

Type: google.cloud.recaptchaenterprise_v1.types.TransactionEvent

class Annotation(value)[source]¶

Bases: proto.enums.Enum

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.

class Reason(value)[source]¶

Bases: proto.enums.Enum

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.

class google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Empty response for AnnotateAssessment.

class google.cloud.recaptchaenterprise_v1.types.AppleDeveloperId(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

private_key¶

Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.

Type: str

key_id¶

Required. The Apple developer key ID (10-character string).

Type: str

team_id¶

Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.

Type: str

class google.cloud.recaptchaenterprise_v1.types.Assessment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A reCAPTCHA Enterprise assessment resource.

name¶

Output only. Identifier. The resource name for the Assessment in the format projects/{project}/assessments/{assessment}.

Type: str

event¶

Optional. The event being assessed.

Type: google.cloud.recaptchaenterprise_v1.types.Event

risk_analysis¶

Output only. The risk analysis result for the event being assessed.

Type: google.cloud.recaptchaenterprise_v1.types.RiskAnalysis

token_properties¶

Output only. Properties of the provided event token.

Type: google.cloud.recaptchaenterprise_v1.types.TokenProperties

account_verification¶

Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature.

Type: google.cloud.recaptchaenterprise_v1.types.AccountVerificationInfo

account_defender_assessment¶

Output only. Assessment returned by account defender when an account identifier is provided.

Type: google.cloud.recaptchaenterprise_v1.types.AccountDefenderAssessment

private_password_leak_verification¶

Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.

Type: google.cloud.recaptchaenterprise_v1.types.PrivatePasswordLeakVerification

firewall_policy_assessment¶

Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation.

Type: google.cloud.recaptchaenterprise_v1.types.FirewallPolicyAssessment

fraud_prevention_assessment¶

Output only. Assessment returned by Fraud Prevention when TransactionData is provided.

Type: google.cloud.recaptchaenterprise_v1.types.FraudPreventionAssessment

fraud_signals¶

Output only. Fraud Signals specific to the users involved in a payment transaction.

Type: google.cloud.recaptchaenterprise_v1.types.FraudSignals

phone_fraud_assessment¶

Output only. Assessment returned when a site key, a token, and a phone number as user_id are provided. Account defender and SMS toll fraud protection need to be enabled.

Type: google.cloud.recaptchaenterprise_v1.types.PhoneFraudAssessment

assessment_environment¶

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

Type: google.cloud.recaptchaenterprise_v1.types.AssessmentEnvironment

class google.cloud.recaptchaenterprise_v1.types.AssessmentEnvironment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

client¶

Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module’s project. Examples include:

“github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager”
“cloud.google.com/recaptcha/docs/implement-waf-akamai”
“cloud.google.com/recaptcha/docs/implement-waf-cloudflare”
“wordpress.org/plugins/recaptcha-something”.

Type: str

version¶

Optional. The version of the client module. For example, “1.0.0”.

Type: str

class google.cloud.recaptchaenterprise_v1.types.ChallengeMetrics(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Metrics related to challenges.

pageload_count¶

Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.

Type: int

nocaptcha_count¶

Count of nocaptchas (successful verification without a challenge) issued.

Type: int

failed_count¶

Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.

Type: int

passed_count¶

Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.

Type: int

class google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The create assessment request message.

parent¶

Required. The name of the project in which the assessment is created, in the format projects/{project}.

Type: str

assessment¶

Required. The assessment details.

Type: google.cloud.recaptchaenterprise_v1.types.Assessment

class google.cloud.recaptchaenterprise_v1.types.CreateFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The create firewall policy request message.

parent¶

Required. The name of the project this policy applies to, in the format projects/{project}.

Type: str

firewall_policy¶

Required. Information to create the policy.

Type: google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

class google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The create key request message.

parent¶

Required. The name of the project in which the key is created, in the format projects/{project}.

Type: str

key¶

Required. Information to create a reCAPTCHA Enterprise key.

Type: google.cloud.recaptchaenterprise_v1.types.Key

class google.cloud.recaptchaenterprise_v1.types.DeleteFirewallPolicyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The delete firewall policy request message.

name¶

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

Type: str

class google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The delete key request message.

name¶

Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.

Type: str

class google.cloud.recaptchaenterprise_v1.types.EndpointVerificationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.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.

email_address¶

Email address for which to trigger a verification request.

This field is a member of oneof endpoint.

Type: str

phone_number¶

Phone number for which to trigger a verification request. Should be given in E.164 format.

This field is a member of oneof endpoint.

Type: str

request_token¶

Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.

Type: str

last_verification_time¶

Output only. Timestamp of the last successful verification for the endpoint, if any.

Type: google.protobuf.timestamp_pb2.Timestamp

class google.cloud.recaptchaenterprise_v1.types.Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The event being assessed.

token¶

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

Type: str

site_key¶

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

Type: str

user_agent¶

Optional. The user agent present in the request from the user’s device related to this event.

Type: str

user_ip_address¶

Optional. The IP address in the request from the user’s device related to this event.

Type: str

expected_action¶

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

Type: str

hashed_account_id¶

Optional. Deprecated: use user_info.account_id instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

Type: bytes

express¶

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an Express site key.

Type: bool

requested_uri¶

Optional. The URI resource the user requested that triggered an assessment.

Type: str

waf_token_assessment¶

Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.

Type: bool

ja3¶

Optional. JA3 fingerprint for SSL clients.

Type: str

headers¶

Optional. HTTP header information about the request.

Type: MutableSequence[str]

firewall_policy_evaluation¶

Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.

Type: bool

transaction_data¶

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

Type: google.cloud.recaptchaenterprise_v1.types.TransactionData

user_info¶

Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.

Type: google.cloud.recaptchaenterprise_v1.types.UserInfo

fraud_prevention¶

Optional. The Fraud Prevention setting for this assessment.

Type: google.cloud.recaptchaenterprise_v1.types.Event.FraudPrevention

class FraudPrevention(value)[source]¶

Bases: proto.enums.Enum

Setting that controls Fraud Prevention assessments.

Values:

FRAUD_PREVENTION_UNSPECIFIED (0):: Default, unspecified setting. If opted in for automatic detection, fraud_prevention_assessment is returned based on the request. Otherwise, fraud_prevention_assessment is returned if transaction_data is present in the Event and Fraud Prevention is enabled in the Google Cloud console.
ENABLED (1):: Enable Fraud Prevention for this assessment, if Fraud Prevention is enabled in the Google Cloud console.
DISABLED (2):: Disable Fraud Prevention for this assessment, regardless of opt-in status or Google Cloud console settings.

class google.cloud.recaptchaenterprise_v1.types.ExpressKeySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

class google.cloud.recaptchaenterprise_v1.types.FirewallAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

allow¶

The user request did not match any policy and should be allowed access to the requested resource.