Package types (0.4.2)

API documentation for recaptchaenterprise_v1.types package.

Classes

AndroidKeySettings

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

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

:type: Sequence[str]

AnnotateAssessmentRequest

The request message to annotate an Assessment. .. attribute:: name

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

:type: str

AnnotateAssessmentResponse

Empty response for AnnotateAssessment.

Assessment

A recaptcha assessment resource. .. attribute:: name

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

:type: str

CreateAssessmentRequest

The create assessment request message. .. attribute:: parent

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

:type: str

CreateKeyRequest

The create key request message. .. attribute:: parent

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

:type: str

DeleteKeyRequest

The delete key request message. .. attribute:: name

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

:type: str

Event

GetKeyRequest

The get key request message. .. attribute:: name

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

:type: str

IOSKeySettings

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

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

:type: Sequence[str]

Key

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

ListKeysRequest

The list keys request message. .. attribute:: parent

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

:type: str

ListKeysResponse

Response to request to list keys in a project. .. attribute:: keys

Key details.

:type: Sequence[google.cloud.recaptchaenterprise_v1.types.Key]

RiskAnalysis

Risk analysis result for an event. .. attribute:: score

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

:type: float

TokenProperties

UpdateKeyRequest

The update key request message. .. attribute:: key

Required. The key to update.

:type: google.cloud.recaptchaenterprise_v1.types.Key

WebKeySettings

Settings specific to keys that can be used by websites. .. attribute:: allow_all_domains

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

:type: bool