Class RecaptchaEnterpriseServiceClient (1.22.0)

Service to determine the likelihood an event is legitimate.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the recaptcha enterprise service client.

Releases underlying transport's resources.

Adds an IP override to a key. The following restrictions hold:

• The maximum number of IP overrides per key is 100.
• For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_add_ip_override():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    ip_override_data = recaptchaenterprise_v1.IpOverrideData()
    ip_override_data.ip = "ip_value"
    ip_override_data.override_type = "ALLOW"

    request = recaptchaenterprise_v1.AddIpOverrideRequest(
        name="name_value",
        ip_override_data=ip_override_data,
    )

    # Make the request
    response = client.add_ip_override(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_annotate_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.AnnotateAssessmentRequest(
        name="name_value",
    )

    # Make the request
    response = client.annotate_assessment(request=request)

    # Handle the response
    print(response)

Returns a fully-qualified assessment string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates an Assessment of the likelihood an event is legitimate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateAssessmentRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_assessment(request=request)

    # Handle the response
    print(response)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateFirewallPolicyRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_firewall_policy(request=request)

    # Handle the response
    print(response)

Creates a new reCAPTCHA Enterprise key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.CreateKeyRequest(
        parent="parent_value",
        key=key,
    )

    # Make the request
    response = client.create_key(request=request)

    # Handle the response
    print(response)

Deletes the specified firewall policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_delete_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    client.delete_firewall_policy(request=request)

Deletes the specified key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_delete_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteKeyRequest(
        name="name_value",
    )

    # Make the request
    client.delete_key(request=request)

Returns a fully-qualified firewall_policy string.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Returns the specified firewall policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_firewall_policy(request=request)

    # Handle the response
    print(response)

Returns the specified key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetKeyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_key(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_metrics():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetMetricsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_metrics(request=request)

    # Handle the response
    print(response)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Returns a fully-qualified key string.

Returns the list of all firewall policies that belong to a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListFirewallPoliciesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_firewall_policies(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_keys():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListKeysRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_keys(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Get memberships in a group of related accounts.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_group_memberships(request=request)

    # Handle the response
    for response in page_result:
        print(response)

List groups of related accounts.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_related_account_groups():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_groups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Returns a fully-qualified metrics string.

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_migrate_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.MigrateKeyRequest(
        name="name_value",
    )

    # Make the request
    response = client.migrate_key(request=request)

    # Handle the response
    print(response)

Parses a assessment path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a firewall_policy path into its component segments.

Parses a key path into its component segments.

Parses a metrics path into its component segments.

Parses a related_account_group_membership path into its component segments.

Parses a related_account_group path into its component segments.

Returns a fully-qualified related_account_group_membership string.

Returns a fully-qualified related_account_group string.

Reorders all firewall policies.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_reorder_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ReorderFirewallPoliciesRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    response = client.reorder_firewall_policies(request=request)

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_retrieve_legacy_secret_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest(
        key="key_value",
    )

    # Make the request
    response = client.retrieve_legacy_secret_key(request=request)

    # Handle the response
    print(response)

Search group memberships related to a given account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_search_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.search_related_account_group_memberships(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Updates the specified firewall policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_update_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.UpdateFirewallPolicyRequest(
    )

    # Make the request
    response = client.update_firewall_policy(request=request)

    # Handle the response
    print(response)

Updates the specified key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_update_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.UpdateKeyRequest(
        key=key,
    )

    # Make the request
    response = client.update_key(request=request)

    # Handle the response
    print(response)