openapi-directory/api/googleapis.com/recaptchaenterprise.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://recaptchaenterprise.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Help protect your website from fraudulent activity, spam, and abuse without creating friction.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"reCAPTCHA Enterprise API","version":"v1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"openapi","url":"https://recaptchaenterprise.googleapis.com/$discovery/rest?version=v1","version":"3.0"}],"x-providerName":"googleapis.com","x-serviceName":"recaptchaenterprise"},"externalDocs":{"url":"https://cloud.google.com/recaptcha-enterprise/"},"tags":[{"name":"projects"}],"paths":{"/v1/{key}:retrieveLegacySecretKey":{"get":{"description":"Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.","operationId":"recaptchaenterprise.projects.keys.retrieveLegacySecretKey","parameters":[{"description":"Required. The public key name linked to the requested secret key in the format `projects/{project}/keys/{key}`.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}":{"delete":{"description":"Deletes the specified key.","operationId":"recaptchaenterprise.projects.keys.delete","parameters":[{"description":"Required. The name of the key to be deleted, in the format `projects/{project}/keys/{key}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleProtobufEmpty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Get some aggregated metrics for a Key. This data can be used to build dashboards.","operationId":"recaptchaenterprise.projects.keys.getMetrics","parameters":[{"description":"Required. The name of the requested metrics, in the format `projects/{project}/keys/{key}/metrics`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Metrics"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates the specified key.","operationId":"recaptchaenterprise.projects.keys.patch","parameters":[{"description":"Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:annotate":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.","operationId":"recaptchaenterprise.projects.assessments.annotate","parameters":[{"description":"Required. The resource name of the Assessment, in the format `projects/{project}/assessments/{assessment}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:migrate":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"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 Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.","operationId":"recaptchaenterprise.projects.keys.migrate","parameters":[{"description":"Required. The name of the key to be migrated, in the format `projects/{project}/keys/{key}`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/assessments":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates an Assessment of the likelihood an event is legitimate.","operationId":"recaptchaenterprise.projects.assessments.create","parameters":[{"description":"Required. The name of the project in which the assessment will be created, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Assessment"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/firewallpolicies":{"get":{"description":"Returns the list of all firewall policies that belong to a project.","operationId":"recaptchaenterprise.projects.firewallpolicies.list","parameters":[{"description":"Required. The name of the project to list the policies for, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.","operationId":"recaptchaenterprise.projects.firewallpolicies.create","parameters":[{"description":"Required. The name of the project this policy will apply to, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/firewallpolicies:reorder":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Reorders all firewall policies.","operationId":"recaptchaenterprise.projects.firewallpolicies.reorder","parameters":[{"description":"Required. The name of the project to list the policies for, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/keys":{"get":{"description":"Returns the list of all keys that belong to a project.","operationId":"recaptchaenterprise.projects.keys.list","parameters":[{"description":"Required. The name of the project that contains the keys that will be listed, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ListKeysResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new reCAPTCHA Enterprise key.","operationId":"recaptchaenterprise.projects.keys.create","parameters":[{"description":"Required. The name of the project in which the key will be created, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/memberships":{"get":{"description":"Get memberships in a group of related accounts.","operationId":"recaptchaenterprise.projects.relatedaccountgroups.memberships.list","parameters":[{"description":"Required. The resource name for the related account group in the format `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships` call. When paginating, all other parameters provided to `ListRelatedAccountGroupMemberships` must match the call that provided the page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{parent}/relatedaccountgroups":{"get":{"description":"List groups of related accounts.","operationId":"recaptchaenterprise.projects.relatedaccountgroups.list","parameters":[{"description":"Required. The name of the project to list related account groups from, in the format `projects/{project}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. A page token, received from a previous `ListRelatedAccountGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRelatedAccountGroups` must match the call that provided the page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{project}/relatedaccountgroupmemberships:search":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Search group memberships related to a given account.","operationId":"recaptchaenterprise.projects.relatedaccountgroupmemberships.search","parameters":[{"description":"Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`.","in":"path","name":"project","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment":{"description":"Account defender risk assessment.","properties":{"labels":{"description":"Output only. Labels for this request.","items":{"enum":["ACCOUNT_DEFENDER_LABEL_UNSPECIFIED","PROFILE_MATCH","SUSPICIOUS_LOGIN_ACTIVITY","SUSPICIOUS_ACCOUNT_CREATION","RELATED_ACCOUNTS_NUMBER_HIGH"],"type":"string"},"readOnly":true,"type":"array"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo":{"description":"Information about account verification, used for identity verification.","properties":{"endpoints":{"description":"Optional. Endpoints that can be used for identity verification.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo"},"type":"array"},"languageCode":{"description":"Optional. Language code preference for the verification message, set as a IETF BCP 47 language code.","type":"string"},"latestVerificationResult":{"description":"Output only. Result of the latest account verification challenge.","enum":["RESULT_UNSPECIFIED","SUCCESS_USER_VERIFIED","ERROR_USER_NOT_VERIFIED","ERROR_SITE_ONBOARDING_INCOMPLETE","ERROR_RECIPIENT_NOT_ALLOWED","ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED","ERROR_CRITICAL_INTERNAL","ERROR_CUSTOMER_QUOTA_EXHAUSTED","ERROR_VERIFICATION_BYPASSED","ERROR_VERDICT_MISMATCH"],"readOnly":true,"type":"string"},"username":{"deprecated":true,"description":"Username of the account that is being verified. Deprecated. Customers should now provide the `account_id` field in `event.user_info`.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1AndroidKeySettings":{"description":"Settings specific to keys that can be used by Android apps.","properties":{"allowAllPackageNames":{"description":"Optional. If set to true, allowed_package_names are not enforced.","type":"boolean"},"allowedPackageNames":{"description":"Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'","items":{"type":"string"},"type":"array"},"supportNonGoogleAppStoreDistribution":{"description":"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":"boolean"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest":{"description":"The request message to annotate an Assessment.","properties":{"accountId":{"description":"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":"string"},"annotation":{"description":"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.","enum":["ANNOTATION_UNSPECIFIED","LEGITIMATE","FRAUDULENT","PASSWORD_CORRECT","PASSWORD_INCORRECT"],"type":"string","x-enumDeprecated":[false,false,false,true,true]},"hashedAccountId":{"description":"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.","format":"byte","type":"string"},"reasons":{"description":"Optional. Reasons for the annotation that are assigned to the event.","items":{"enum":["REASON_UNSPECIFIED","CHARGEBACK","CHARGEBACK_FRAUD","CHARGEBACK_DISPUTE","REFUND","REFUND_FRAUD","TRANSACTION_ACCEPTED","TRANSACTION_DECLINED","PAYMENT_HEURISTICS","INITIATED_TWO_FACTOR","PASSED_TWO_FACTOR","FAILED_TWO_FACTOR","CORRECT_PASSWORD","INCORRECT_PASSWORD","SOCIAL_SPAM"],"type":"string"},"type":"array"},"transactionEvent":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionEvent","description":"Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction."}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse":{"description":"Empty response for AnnotateAssessment.","properties":{},"type":"object"},"GoogleCloudRecaptchaenterpriseV1AppleDeveloperId":{"description":"Contains fields that are required to perform Apple-specific integrity checks.","properties":{"keyId":{"description":"Required. The Apple developer key ID (10-character string).","type":"string"},"privateKey":{"description":"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":"string"},"teamId":{"description":"Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1Assessment":{"description":"A reCAPTCHA Enterprise assessment resource.","properties":{"accountDefenderAssessment":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment","description":"Output only. Assessment returned by account defender when an account identifier is provided.","readOnly":true},"accountVerification":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo","description":"Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature."},"event":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Event","description":"Optional. The event being assessed."},"firewallPolicyAssessment":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment","description":"Output only. Assessment returned when firewall policies belonging to the project are evaluated using the field firewall_policy_evaluation.","readOnly":true},"fraudPreventionAssessment":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment","description":"Output only. Assessment returned by Fraud Prevention when TransactionData is provided.","readOnly":true},"fraudSignals":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignals","description":"Output only. Fraud Signals specific to the users involved in a payment transaction.","readOnly":true},"name":{"description":"Output only. Identifier. The resource name for the Assessment in the format `projects/{project}/assessments/{assessment}`.","readOnly":true,"type":"string"},"privatePasswordLeakVerification":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification","description":"Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials."},"riskAnalysis":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1RiskAnalysis","description":"Output only. The risk analysis result for the event being assessed.","readOnly":true},"tokenProperties":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1TokenProperties","description":"Output only. Properties of the provided event token.","readOnly":true}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1ChallengeMetrics":{"description":"Metrics related to challenges.","properties":{"failedCount":{"description":"Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.","format":"int64","type":"string"},"nocaptchaCount":{"description":"Count of nocaptchas (successful verification without a challenge) issued.","format":"int64","type":"string"},"pageloadCount":{"description":"Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.","format":"int64","type":"string"},"passedCount":{"description":"Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.","format":"int64","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo":{"description":"Information about a verification endpoint that can be used for 2FA.","properties":{"emailAddress":{"description":"Email address for which to trigger a verification request.","type":"string"},"lastVerificationTime":{"description":"Output only. Timestamp of the last successful verification for the endpoint, if any.","format":"google-datetime","readOnly":true,"type":"string"},"phoneNumber":{"description":"Phone number for which to trigger a verification request. Should be given in E.164 format.","type":"string"},"requestToken":{"description":"Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.","readOnly":true,"type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1Event":{"description":"The event being assessed.","properties":{"expectedAction":{"description":"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":"string"},"express":{"description":"Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS.","type":"boolean"},"firewallPolicyEvaluation":{"description":"Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.","type":"boolean"},"hashedAccountId":{"deprecated":true,"description":"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.","format":"byte","type":"string"},"headers":{"description":"Optional. HTTP header information about the request.","items":{"type":"string"},"type":"array"},"ja3":{"description":"Optional. JA3 fingerprint for SSL clients.","type":"string"},"requestedUri":{"description":"Optional. The URI resource the user requested that triggered an assessment.","type":"string"},"siteKey":{"description":"Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.","type":"string"},"token":{"description":"Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.","type":"string"},"transactionData":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1TransactionData","description":"Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response."},"userAgent":{"description":"Optional. The user agent present in the request from the user's device related to this event.","type":"string"},"userInfo":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1UserInfo","description":"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."},"userIpAddress":{"description":"Optional. The IP address in the request from the user's device related to this event.","type":"string"},"wafTokenAssessment":{"description":"Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.","type":"boolean"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallAction":{"description":"An individual action. Each action represents what to do if a policy matches.","properties":{"allow":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction","description":"The user request did not match any policy and should be allowed access to the requested resource."},"block":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction","description":"This action will deny access to a given page. The user will get an HTTP error code."},"includeRecaptchaScript":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction","description":"This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend."},"redirect":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction","description":"This action will redirect the request to a ReCaptcha interstitial to attach a token."},"setHeader":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction","description":"This action will set a custom header but allow the request to continue to the customer backend."},"substitute":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction","description":"This action will transparently serve a different page to an offending user."}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction":{"description":"An allow action continues processing a request unimpeded.","properties":{},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction":{"description":"A block action serves an HTTP error code a prevents the request from hitting the backend.","properties":{},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction":{"description":"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.","properties":{},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction":{"description":"A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.","properties":{},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction":{"description":"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.","properties":{"key":{"description":"Optional. The header key to set in the request to the backend server.","type":"string"},"value":{"description":"Optional. The header value to set in the request to the backend server.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction":{"description":"A substitute action transparently serves a different page than the one requested.","properties":{"path":{"description":"Optional. The address to redirect to. The target is a relative path in the current host. Example: \"/blog/404.html\".","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallPolicy":{"description":"A FirewallPolicy represents a single matching pattern and resulting actions to take.","properties":{"actions":{"description":"Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallAction"},"type":"array"},"condition":{"description":"Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.","type":"string"},"description":{"description":"Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.","type":"string"},"name":{"description":"Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.","type":"string"},"path":{"description":"Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment":{"description":"Policy config assessment.","properties":{"error":{"$ref":"#/components/schemas/GoogleRpcStatus","description":"Output only. If the processing of a policy config fails, an error will be populated and the firewall_policy will be left empty.","readOnly":true},"firewallPolicy":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy","description":"Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the incoming request, the policy field will be left empty.","readOnly":true}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment":{"description":"Assessment for Fraud Prevention.","properties":{"behavioralTrustVerdict":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict","description":"Output only. Assessment of this transaction for behavioral trust.","readOnly":true},"cardTestingVerdict":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict","description":"Output only. Assessment of this transaction for risk of being part of a card testing attack.","readOnly":true},"stolenInstrumentVerdict":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict","description":"Output only. Assessment of this transaction for risk of a stolen instrument.","readOnly":true},"transactionRisk":{"description":"Output only. Probability of this transaction being fraudulent. Summarizes the combined risk of attack vectors below. Values are from 0.0 (lowest) to 1.0 (highest).","format":"float","readOnly":true,"type":"number"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict":{"description":"Information about behavioral trust of the transaction.","properties":{"trust":{"description":"Output only. Probability of this transaction attempt being executed in a behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 (highest).","format":"float","readOnly":true,"type":"number"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict":{"description":"Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details.","properties":{"risk":{"description":"Output only. Probability of this transaction attempt being part of a card testing attack. Values are from 0.0 (lowest) to 1.0 (highest).","format":"float","readOnly":true,"type":"number"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict":{"description":"Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.","properties":{"risk":{"description":"Output only. Probability of this transaction being executed with a stolen instrument. Values are from 0.0 (lowest) to 1.0 (highest).","format":"float","readOnly":true,"type":"number"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudSignals":{"description":"Fraud signals describing users and cards involved in the transaction.","properties":{"cardSignals":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals","description":"Output only. Signals describing the payment card or cards used in this transaction.","readOnly":true},"userSignals":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals","description":"Output only. Signals describing the end user in this transaction.","readOnly":true}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudSignalsCardSignals":{"description":"Signals describing the payment card used in this transaction.","properties":{"cardLabels":{"description":"Output only. The labels for the payment card in this transaction.","items":{"enum":["CARD_LABEL_UNSPECIFIED","PREPAID","VIRTUAL","UNEXPECTED_LOCATION"],"type":"string"},"readOnly":true,"type":"array"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1FraudSignalsUserSignals":{"description":"Signals describing the user involved in this transaction.","properties":{"activeDaysLowerBound":{"description":"Output only. This user (based on email, phone, and other identifiers) has been seen on the internet for at least this number of days.","format":"int32","readOnly":true,"type":"integer"},"syntheticRisk":{"description":"Output only. Likelihood (from 0.0 to 1.0) this user includes synthetic components in their identity, such as a randomly generated email address, temporary phone number, or fake shipping address.","format":"float","readOnly":true,"type":"number"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1IOSKeySettings":{"description":"Settings specific to keys that can be used by iOS apps.","properties":{"allowAllBundleIds":{"description":"Optional. If set to true, allowed_bundle_ids are not enforced.","type":"boolean"},"allowedBundleIds":{"description":"Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'","items":{"type":"string"},"type":"array"},"appleDeveloperId":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AppleDeveloperId","description":"Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app."}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1Key":{"description":"A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.","properties":{"androidSettings":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1AndroidKeySettings","description":"Settings for keys that can be used by Android apps."},"createTime":{"description":"Output only. The timestamp corresponding to the creation of this key.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Required. Human-readable display name of this key. Modifiable by user.","type":"string"},"iosSettings":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1IOSKeySettings","description":"Settings for keys that can be used by iOS apps."},"labels":{"additionalProperties":{"type":"string"},"description":"Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).","type":"object"},"name":{"description":"Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`.","type":"string"},"testingOptions":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1TestingOptions","description":"Optional. Options for user acceptance testing."},"wafSettings":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1WafSettings","description":"Optional. Settings for WAF"},"webSettings":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1WebKeySettings","description":"Settings for keys that can be used by websites."}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse":{"description":"Response to request to list firewall policies belonging to a key.","properties":{"firewallPolicies":{"description":"Policy details.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1FirewallPolicy"},"type":"array"},"nextPageToken":{"description":"Token to retrieve the next page of results. It is set to empty if no policies remain in results.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1ListKeysResponse":{"description":"Response to request to list keys in a project.","properties":{"keys":{"description":"Key details.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1Key"},"type":"array"},"nextPageToken":{"description":"Token to retrieve the next page of results. It is set to empty if no keys remain in results.","type":"string"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse":{"description":"The response to a `ListRelatedAccountGroupMemberships` call.","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"relatedAccountGroupMemberships":{"description":"The memberships listed by the query.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroupMembership"},"type":"array"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse":{"description":"The response to a `ListRelatedAccountGroups` call.","properties":{"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.","type":"string"},"relatedAccountGroups":{"description":"The groups of related accounts listed by the query.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1RelatedAccountGroup"},"type":"array"}},"type":"object"},"GoogleCloudRecaptchaenterpriseV1Metrics":{"description":"Metrics for a single Key.","properties":{"challengeMetrics":{"description":"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.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ChallengeMetrics"},"type":"array"},"name":{"description":"Output only. Identifier. The name of the metrics, in the format `projects/{project}/keys/{key}/metrics`.","readOnly":true,"type":"string"},"scoreMetrics":{"description":"Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.","items":{"$ref":"#/components/schemas/GoogleCloudRecaptchaenterpriseV1ScoreMetrics"},"type":"array"},"startTime":{"description":"Inclusive start time aligned to a day (UTC)