RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Service to determine the likelihood an event is legitimate.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
RecaptchaEnterpriseServiceTransport | The transport used by the client instance. |
Methods
RecaptchaEnterpriseServiceClient
RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the recaptcha enterprise service client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, RecaptchaEnterpriseServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
annotate_assessment
annotate_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, *, name: Optional[str] = None, annotation: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]
The request object. The request message to annotate an Assessment. |
name |
str
Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}". This corresponds to the |
annotation |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.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. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse | Empty response for AnnotateAssessment. |
assessment_path
assessment_path(project: str, assessment: str)Returns a fully-qualified assessment string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_assessment
create_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest, dict]] = None, *, parent: Optional[str] = None, assessment: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]
The request object. The create assessment request message. |
parent |
str
Required. The name of the project in which the assessment will be created, in the format "projects/{project}". This corresponds to the |
assessment |
google.cloud.recaptchaenterprise_v1.types.Assessment
Required. The assessment details. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Assessment | A recaptcha assessment resource. |
create_key
create_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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"
request = recaptchaenterprise_v1.CreateKeyRequest(
parent="parent_value",
key=key,
)
# Make the request
response = client.create_key(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]
The request object. The create key request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |
delete_key
delete_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]
The request object. The delete key request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
get_key
get_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]
The request object. The get key request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |
get_metrics
get_metrics(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]
The request object. The get metrics request message. |
name |
str
Required. The name of the requested metrics, in the format "projects/{project}/keys/{key}/metrics". This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Metrics | Metrics for a single Key. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)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 variabel 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.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
key_path
key_path(project: str, key: str)Returns a fully-qualified key string.
list_keys
list_keys(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]
The request object. The list keys request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager | Response to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically. |
list_related_account_group_memberships
list_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]
The request object. The request message to list memberships in a related account group. |
parent |
str
Required. The resource name for the related account group in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager | The response to a ListRelatedAccountGroupMemberships call. Iterating over this object will yield results and resolve additional pages automatically. |
list_related_account_groups
list_related_account_groups(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]
The request object. The request message to list related account groups. |
parent |
str
Required. The name of the project to list related account groups from, in the format "projects/{project}". This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager | The response to a ListRelatedAccountGroups call. Iterating over this object will yield results and resolve additional pages automatically. |
metrics_path
metrics_path(project: str, key: str)Returns a fully-qualified metrics string.
migrate_key
migrate_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
# 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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]
The request object. The migrate key request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |
parse_assessment_path
parse_assessment_path(path: str)Parses a assessment path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_key_path
parse_key_path(path: str)Parses a key path into its component segments.
parse_metrics_path
parse_metrics_path(path: str)Parses a metrics path into its component segments.
parse_related_account_group_membership_path
parse_related_account_group_membership_path(path: str)Parses a related_account_group_membership path into its component segments.
parse_related_account_group_path
parse_related_account_group_path(path: str)Parses a related_account_group path into its component segments.
related_account_group_membership_path
related_account_group_membership_path(
project: str, relatedaccountgroup: str, membership: str
)Returns a fully-qualified related_account_group_membership string.
related_account_group_path
related_account_group_path(project: str, relatedaccountgroup: str)Returns a fully-qualified related_account_group string.
retrieve_legacy_secret_key
retrieve_legacy_secret_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, *, key: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]
The request object. The retrieve legacy secret key request message. |
key |
str
Required. The public key name linked to the requested secret key in the format "projects/{project}/keys/{key}". This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse | Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA. |
search_related_account_group_memberships
search_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, *, project: Optional[str] = None, hashed_account_id: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]
The request object. The request message to search related account group memberships. |
project |
str
Required. The name of the project to search related account group memberships from. Specify the project name in the following format: "projects/{project}". This corresponds to the |
hashed_account_id |
bytes
Optional. The unique stable hashed user identifier we should search connections to. The identifier should correspond to a |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager | The response to a SearchRelatedAccountGroupMemberships call. Iterating over this object will yield results and resolve additional pages automatically. |
update_key
update_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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"
request = recaptchaenterprise_v1.UpdateKeyRequest(
key=key,
)
# Make the request
response = client.update_key(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]
The request object. The update key request message. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |