Package google.cloud.recaptchaenterprise.v1

Index

RecaptchaEnterpriseService

Service to determine the likelihood an event is legitimate.

AnnotateAssessment

rpc AnnotateAssessment(AnnotateAssessmentRequest) returns (AnnotateAssessmentResponse)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.assessments.annotate

For more information, see the IAM documentation.
CreateAssessment

rpc CreateAssessment(CreateAssessmentRequest) returns (Assessment)

Creates an Assessment of the likelihood an event is legitimate.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • recaptchaenterprise.assessments.create

For more information, see the IAM documentation.
CreateKey

rpc CreateKey(CreateKeyRequest) returns (Key)

Creates a new reCAPTCHA Enterprise key.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • recaptchaenterprise.keys.create

For more information, see the IAM documentation.
DeleteKey

rpc DeleteKey(DeleteKeyRequest) returns (Empty)

Deletes the specified key.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.keys.delete

For more information, see the IAM documentation.
GetKey

rpc GetKey(GetKeyRequest) returns (Key)

Returns the specified key.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.keys.get

For more information, see the IAM documentation.
GetMetrics

rpc GetMetrics(GetMetricsRequest) returns (Metrics)

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.metrics.get

For more information, see the IAM documentation.
ListKeys

rpc ListKeys(ListKeysRequest) returns (ListKeysResponse)

Returns the list of all keys that belong to a project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • recaptchaenterprise.keys.list

For more information, see the IAM documentation.
MigrateKey

rpc MigrateKey(MigrateKeyRequest) returns (Key)

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.keys.update

For more information, see the IAM documentation.
UpdateKey

rpc UpdateKey(UpdateKeyRequest) returns (Key)

Updates the specified key.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.keys.update

For more information, see the IAM documentation.

AndroidKeySettings

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

Fields
allow_all_package_names

bool

If set to true, allowed_package_names are not enforced.
allowed_package_names[]

string

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

AnnotateAssessmentRequest

The request message to annotate an Assessment.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • recaptchaenterprise.assessments.annotate
annotation

Annotation

Optional. The annotation that will be 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.
reasons[]

Reason

Optional. Optional reasons for the annotation that will be assigned to the Event.

Annotation

Enum that represents the types of annotations.

Enums
ANNOTATION_UNSPECIFIED Default unspecified type.
LEGITIMATE Provides information that the event turned out to be legitimate.
FRAUDULENT Provides information that the event turned out to be fraudulent.
PASSWORD_CORRECT

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

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.

Enums
REASON_UNSPECIFIED Default unspecified reason.
CHARGEBACK Indicates a chargeback for fraud was issued for the transaction associated with the assessment.
PAYMENT_HEURISTICS 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 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 Indicates that the user passed a 2FA challenge.
FAILED_TWO_FACTOR Indicates that the user failed a 2FA challenge.
CORRECT_PASSWORD Indicates the user provided the correct password.
INCORRECT_PASSWORD Indicates the user provided an incorrect password.

AnnotateAssessmentResponse

Empty response for AnnotateAssessment.

Assessment

A recaptcha assessment resource.

Fields
name

string

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

Event

The event being assessed.
risk_analysis

RiskAnalysis

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

TokenProperties

Output only. Properties of the provided event token.

ChallengeMetrics

Metrics related to challenges.

Fields
pageload_count

int64

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

int64

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

int64

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

int64

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

CreateAssessmentRequest

The create assessment request message.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • recaptchaenterprise.assessments.create
assessment

Assessment

Required. The assessment details.

CreateKeyRequest

The create key request message.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • recaptchaenterprise.keys.create
key

Key

Required. Information to create a reCAPTCHA Enterprise key.

DeleteKeyRequest

The delete key request message.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • recaptchaenterprise.keys.delete

Event

Fields
token

string

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

string

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

string

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

string

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

string

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.

GetKeyRequest

The get key request message.

Fields
name

string

Required. The name of the requested key, in the format "projects/{project}/keys/{key}".

Authorization requires the following IAM permission on the specified resource name:

  • recaptchaenterprise.keys.get

GetMetricsRequest

The get metrics request message.

Fields
name

string

Required. The name of the requested metrics, in the format "projects/{project}/keys/{key}/metrics".

Authorization requires the following IAM permission on the specified resource name:

  • recaptchaenterprise.metrics.get

IOSKeySettings

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

Fields
allow_all_bundle_ids

bool

If set to true, allowed_bundle_ids are not enforced.
allowed_bundle_ids[]

string

iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

Key

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

Fields
name

string

The resource name for the Key in the format "projects/{project}/keys/{key}".
display_name

string

Human-readable display name of this key. Modifiable by user.
labels

map<string, string>

See Creating and managing labels.
create_time

Timestamp

The timestamp corresponding to the creation of this Key.
testing_options

TestingOptions

Options for user acceptance testing.
Union field platform_settings. Platform specific settings for this key. The key can only be used on one platform, the one it has settings for. platform_settings can be only one of the following:
web_settings

WebKeySettings

Settings for keys that can be used by websites.
android_settings

AndroidKeySettings

Settings for keys that can be used by Android apps.
ios_settings

IOSKeySettings

Settings for keys that can be used by iOS apps.

ListKeysRequest

The list keys request message.

Fields
parent

string

Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}".

Authorization requires the following IAM permission on the specified resource parent:

  • recaptchaenterprise.keys.list
page_size

int32

Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
page_token

string

Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.

ListKeysResponse

Response to request to list keys in a project.

Fields
keys[]

Key

Key details.
next_page_token

string

Token to retrieve the next page of results. It is set to empty if no keys remain in results.

Metrics

Metrics for a single Key.

Fields
name

string

Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".
start_time

Timestamp

Inclusive start time aligned to a day (UTC).
score_metrics[]

ScoreMetrics

Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
challenge_metrics[]

ChallengeMetrics

Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.

MigrateKeyRequest

The migrate key request message.

Fields
name

string

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

Authorization requires the following IAM permission on the specified resource name:

  • recaptchaenterprise.keys.update

RiskAnalysis

Risk analysis result for an event.

Fields
score

float

Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).
reasons[]

ClassificationReason

Reasons contributing to the risk analysis verdict.

ClassificationReason

Reasons contributing to the risk analysis verdict.

Enums
CLASSIFICATION_REASON_UNSPECIFIED Default unspecified type.
AUTOMATION Interactions matched the behavior of an automated agent.
UNEXPECTED_ENVIRONMENT The event originated from an illegitimate environment.
TOO_MUCH_TRAFFIC Traffic volume from the event source is higher than normal.
UNEXPECTED_USAGE_PATTERNS Interactions with the site were significantly different than expected patterns.
LOW_CONFIDENCE_SCORE Too little traffic has been received from this site thus far to generate quality risk analysis.

ScoreDistribution

Score distribution.

Fields
score_buckets

map<int32, int64>

Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).

ScoreMetrics

Metrics related to scoring.

Fields
overall_metrics

ScoreDistribution

Aggregated score metrics for all traffic.
action_metrics

map<string, ScoreDistribution>

Action-based metrics. The map key is the action name which specified by the site owners at time of the "execute" client-side call. Populated only for SCORE keys.

TestingOptions

Options for user acceptance testing.

Fields
testing_score

float

All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
testing_challenge

TestingChallenge

For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.

TestingChallenge

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

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

TokenProperties

Fields
valid

bool

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).
invalid_reason

InvalidReason

Reason associated with the response when valid = false.
create_time

Timestamp

The timestamp corresponding to the generation of the token.
hostname

string

The hostname of the page on which the token was generated.
action

string

Action name provided at token generation.

InvalidReason

Enum that represents the types of invalid token reasons.

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

UpdateKeyRequest

The update key request message.

Fields
key

Key

Required. The key to update.

Authorization requires the following IAM permission on the specified resource key:

  • recaptchaenterprise.keys.update
update_mask

FieldMask

Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.

WebKeySettings

Settings specific to keys that can be used by websites.

Fields
allow_all_domains

bool

If set to true, it means allowed_domains will not be enforced.
allowed_domains[]

string

Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
allow_amp_traffic

bool

If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
integration_type

IntegrationType

Required. Describes how this key is integrated with the website.
challenge_security_preference

ChallengeSecurityPreference

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

ChallengeSecurityPreference

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

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

IntegrationType

Enum that represents the integration types for web keys.

Enums
INTEGRATION_TYPE_UNSPECIFIED 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 Only used to produce scores. It doesn't display the "I'm not a robot" checkbox and never shows captcha challenges.
CHECKBOX Displays the "I'm not a robot" checkbox and may show captcha challenges after it is checked.
INVISIBLE Doesn't display the "I'm not a robot" checkbox, but may show captcha challenges after risk analysis.