Google Cloud reCAPTCHA Enterprise v1 API - Namespace Google.Cloud.RecaptchaEnterprise.V1 (2.12.0)

Classes

AccountDefenderAssessment

Account defender risk assessment.

AccountDefenderAssessment.Types

Container for nested types declared in the AccountDefenderAssessment message type.

AccountVerificationInfo

Information about account verification, used for identity verification.

AccountVerificationInfo.Types

Container for nested types declared in the AccountVerificationInfo message type.

AndroidKeySettings

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

AnnotateAssessmentRequest

The request message to annotate an Assessment.

AnnotateAssessmentRequest.Types

Container for nested types declared in the AnnotateAssessmentRequest message type.

AnnotateAssessmentResponse

Empty response for AnnotateAssessment.

AppleDeveloperId

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

Assessment

A reCAPTCHA Enterprise assessment resource.

AssessmentName

Resource name for the 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.

Event

The event being assessed.

FirewallAction

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

FirewallAction.Types

Container for nested types declared in the FirewallAction message type.

FirewallAction.Types.AllowAction

An allow action continues processing a request unimpeded.

FirewallAction.Types.BlockAction

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

FirewallAction.Types.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.

FirewallAction.Types.RedirectAction

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

FirewallAction.Types.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.

FirewallAction.Types.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.

FirewallPolicyName

Resource name for the FirewallPolicy resource.

FraudPreventionAssessment

Assessment for Fraud Prevention.

FraudPreventionAssessment.Types

Container for nested types declared in the FraudPreventionAssessment message type.

FraudPreventionAssessment.Types.BehavioralTrustVerdict

Information about behavioral trust of the transaction.

FraudPreventionAssessment.Types.CardTestingVerdict

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

FraudPreventionAssessment.Types.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.

FraudSignals.Types

Container for nested types declared in the FraudSignals message type.

FraudSignals.Types.CardSignals

Signals describing the payment card used in this transaction.

FraudSignals.Types.CardSignals.Types

Container for nested types declared in the CardSignals message type.

FraudSignals.Types.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.

KeyName

Resource name for the Key resource.

ListFirewallPoliciesRequest

The list firewall policies request message.

ListFirewallPoliciesResponse

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

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.

MetricsName

Resource name for the Metrics resource.

MigrateKeyRequest

The migrate key request message.

PrivatePasswordLeakVerification

Private password leak verification info.

RecaptchaEnterpriseService

Service to determine the likelihood an event is legitimate.

RecaptchaEnterpriseService.RecaptchaEnterpriseServiceBase

Base class for server-side implementations of RecaptchaEnterpriseService

RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient

Client for RecaptchaEnterpriseService

RecaptchaEnterpriseServiceClient

RecaptchaEnterpriseService client wrapper, for convenient use.

RecaptchaEnterpriseServiceClientBuilder

Builder class for RecaptchaEnterpriseServiceClient to provide simple configuration of credentials, endpoint etc.

RecaptchaEnterpriseServiceClientImpl

RecaptchaEnterpriseService client wrapper implementation, for convenient use.

RecaptchaEnterpriseServiceSettings

Settings for RecaptchaEnterpriseServiceClient instances.

RelatedAccountGroup

A group of related accounts.

RelatedAccountGroupMembership

A membership in a group of related accounts.

RelatedAccountGroupMembershipName

Resource name for the RelatedAccountGroupMembership resource.

RelatedAccountGroupName

Resource name for the RelatedAccountGroup resource.

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.

RiskAnalysis.Types

Container for nested types declared in the RiskAnalysis message type.

ScoreDistribution

Score distribution.

ScoreMetrics

Metrics related to scoring.

SearchRelatedAccountGroupMembershipsRequest

The request message to search related account group memberships.

SearchRelatedAccountGroupMembershipsResponse

The response to a SearchRelatedAccountGroupMemberships call.

TestingOptions

Options for user acceptance testing.

TestingOptions.Types

Container for nested types declared in the TestingOptions message type.

TokenProperties

Properties of the provided event token.

TokenProperties.Types

Container for nested types declared in the TokenProperties message type.

TransactionData

Transaction data associated with a payment protected by reCAPTCHA Enterprise.

TransactionData.Types

Container for nested types declared in the TransactionData message type.

TransactionData.Types.Address

Structured address format for billing and shipping addresses.

TransactionData.Types.GatewayInfo

Details about the transaction from the gateway.

TransactionData.Types.Item

Line items being purchased in this transaction.

TransactionData.Types.User

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

TransactionEvent

Describes an event in the lifecycle of a payment transaction.

TransactionEvent.Types

Container for nested types declared in the TransactionEvent message type.

UpdateFirewallPolicyRequest

The update firewall policy request message.

UpdateKeyRequest

The update key request message.

UserId

An identifier associated with a user.

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

WafSettings.Types

Container for nested types declared in the WafSettings message type.

WebKeySettings

Settings specific to keys that can be used by websites.

WebKeySettings.Types

Container for nested types declared in the WebKeySettings message type.

Enums

AccountDefenderAssessment.Types.AccountDefenderLabel

Labels returned by account defender for this request.

AccountVerificationInfo.Types.Result

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

AnnotateAssessmentRequest.Types.Annotation

Enum that represents the types of annotations.

AnnotateAssessmentRequest.Types.Reason

Enum that represents potential reasons for annotating an assessment.

AssessmentName.ResourceNameType

The possible contents of AssessmentName.

EndpointVerificationInfo.EndpointOneofCase

Enum of possible cases for the "endpoint" oneof.

FirewallAction.FirewallActionOneofOneofCase

Enum of possible cases for the "firewall_action_oneof" oneof.

FirewallPolicyName.ResourceNameType

The possible contents of FirewallPolicyName.

FraudSignals.Types.CardSignals.Types.CardLabel

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

Key.PlatformSettingsOneofCase

Enum of possible cases for the "platform_settings" oneof.

KeyName.ResourceNameType

The possible contents of KeyName.

MetricsName.ResourceNameType

The possible contents of MetricsName.

RelatedAccountGroupMembershipName.ResourceNameType

The possible contents of RelatedAccountGroupMembershipName.

RelatedAccountGroupName.ResourceNameType

The possible contents of RelatedAccountGroupName.

RiskAnalysis.Types.ClassificationReason

Reasons contributing to the risk analysis verdict.

TestingOptions.Types.TestingChallenge

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

TokenProperties.Types.InvalidReason

Enum that represents the types of invalid token reasons.

TransactionEvent.Types.TransactionEventType

Enum that represents an event in the payment transaction lifecycle.

UserId.IdOneofOneofCase

Enum of possible cases for the "id_oneof" oneof.

WafSettings.Types.WafFeature

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

WafSettings.Types.WafService

Web Application Firewalls supported by reCAPTCHA Enterprise.

WebKeySettings.Types.ChallengeSecurityPreference

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

WebKeySettings.Types.IntegrationType

Enum that represents the integration types for web keys.