Class TokenProperties (1.13.0)

TokenProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Properties of the provided event token.

Attributes

NameDescription
valid bool
Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).
invalid_reason google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason
Reason associated with the response when valid = false.
create_time google.protobuf.timestamp_pb2.Timestamp
The timestamp corresponding to the generation of the token.
hostname str
The hostname of the page on which the token was generated (Web keys only).
android_package_name str
The name of the Android package with which the token was generated (Android keys only).
ios_bundle_id str
The ID of the iOS bundle with which the token was generated (iOS keys only).
action str
Action name provided at token generation.

Classes

InvalidReason

InvalidReason(value)

Enum that represents the types of invalid token reasons.

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