recaptchaenterprise/v1 library
reCAPTCHA Enterprise API - v1
Help protect your website from fraudulent activity, spam, and abuse without creating friction.
For more information, see cloud.google.com/recaptcha-enterprise/
Create an instance of RecaptchaEnterpriseApi to access these resources:
Classes
- GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment
- Account defender risk assessment.
- GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo
- Information about account verification, used for identity verification.
- GoogleCloudRecaptchaenterpriseV1AndroidKeySettings
- Settings specific to keys that can be used by Android apps.
- GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest
- The request message to annotate an Assessment.
- GoogleCloudRecaptchaenterpriseV1AppleDeveloperId
- Contains fields that are required to perform Apple-specific integrity checks.
- GoogleCloudRecaptchaenterpriseV1Assessment
- A reCAPTCHA Enterprise assessment resource.
- GoogleCloudRecaptchaenterpriseV1ChallengeMetrics
- Metrics related to challenges.
- GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo
- Information about a verification endpoint that can be used for 2FA.
- GoogleCloudRecaptchaenterpriseV1Event
- The event being assessed.
- GoogleCloudRecaptchaenterpriseV1FirewallAction
- An individual action.
- GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction
- A set header action sets a header and forwards the request to the backend.
- GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction
- A substitute action transparently serves a different page than the one requested.
- GoogleCloudRecaptchaenterpriseV1FirewallPolicy
- A FirewallPolicy represents a single matching pattern and resulting actions to take.
- GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment
- Policy config assessment.
- GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment
- Assessment for Fraud Prevention.
- GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict
- Information about behavioral trust of the transaction.
- GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict
- Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.
- GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict
- Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.
- GoogleCloudRecaptchaenterpriseV1FraudSignals
- Fraud signals describing users and cards involved in the transaction.
- GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals
- Signals describing the payment card used in this transaction.
- GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals
- Signals describing the user involved in this transaction.
- GoogleCloudRecaptchaenterpriseV1IOSKeySettings
- Settings specific to keys that can be used by iOS apps.
- GoogleCloudRecaptchaenterpriseV1Key
- A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
- GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse
- Response to request to list firewall policies belonging to a project.
- GoogleCloudRecaptchaenterpriseV1ListKeysResponse
- Response to request to list keys in a project.
- GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse
-
The response to a
ListRelatedAccountGroupMembershipscall. - GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse
-
The response to a
ListRelatedAccountGroupscall. - GoogleCloudRecaptchaenterpriseV1Metrics
- Metrics for a single Key.
- GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest
- The migrate key request message.
- GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment
- Assessment for Phone Fraud
- GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification
- Private password leak verification info.
- GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup
- A group of related accounts.
- GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership
- A membership in a group of related accounts.
- GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest
- The reorder firewall policies request message.
- GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse
- Secret key is used only in legacy reCAPTCHA.
- GoogleCloudRecaptchaenterpriseV1RiskAnalysis
- Risk analysis result for an event.
- GoogleCloudRecaptchaenterpriseV1ScoreDistribution
- Score distribution.
- GoogleCloudRecaptchaenterpriseV1ScoreMetrics
- Metrics related to scoring.
- GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest
- The request message to search related account group memberships.
- GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse
-
The response to a
SearchRelatedAccountGroupMembershipscall. - GoogleCloudRecaptchaenterpriseV1SmsTollFraudVerdict
- Information about SMS toll fraud.
- GoogleCloudRecaptchaenterpriseV1TestingOptions
- Options for user acceptance testing.
- GoogleCloudRecaptchaenterpriseV1TokenProperties
- Properties of the provided event token.
- GoogleCloudRecaptchaenterpriseV1TransactionData
- Transaction data associated with a payment protected by reCAPTCHA Enterprise.
- GoogleCloudRecaptchaenterpriseV1TransactionDataAddress
- Structured address format for billing and shipping addresses.
- GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo
- Details about the transaction from the gateway.
- GoogleCloudRecaptchaenterpriseV1TransactionDataItem
- Line items being purchased in this transaction.
- GoogleCloudRecaptchaenterpriseV1TransactionDataUser
- Details about a user's account involved in the transaction.
- GoogleCloudRecaptchaenterpriseV1TransactionEvent
- Describes an event in the lifecycle of a payment transaction.
- GoogleCloudRecaptchaenterpriseV1UserId
- An identifier associated with a user.
- GoogleCloudRecaptchaenterpriseV1UserInfo
- User information associated with a request protected by reCAPTCHA Enterprise.
- GoogleCloudRecaptchaenterpriseV1WafSettings
- Settings specific to keys that can be used for WAF (Web Application Firewall).
- GoogleCloudRecaptchaenterpriseV1WebKeySettings
- Settings specific to keys that can be used by websites.
- ProjectsAssessmentsResource
- ProjectsFirewallpoliciesResource
- ProjectsKeysResource
- ProjectsRelatedaccountgroupmembershipsResource
- ProjectsRelatedaccountgroupsMembershipsResource
- ProjectsRelatedaccountgroupsResource
- ProjectsResource
- RecaptchaEnterpriseApi
- Help protect your website from fraudulent activity, spam, and abuse without creating friction.
Typedefs
- GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse = $Empty
- Empty response for AnnotateAssessment.
- GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction = $Empty
- An allow action continues processing a request unimpeded.
- GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction = $Empty
- A block action serves an HTTP error code a prevents the request from hitting the backend.
- GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction = $Empty
- An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend.
- GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction = $Empty
- A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.
- GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse = $Empty
- The reorder firewall policies response message.
- GoogleProtobufEmpty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- GoogleRpcStatus = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.