Class TokenProperties (1.33.0) 

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

Properties of the provided event token.

Attributes
Name Description
valid bool
Output only. Indicates whether the provided user response token is valid. If false, the token is invalid, either because the user failed the challenge or for a reason provided in the invalid_reason field.
invalid_reason google.cloud.recaptchaenterprise_v1.types.TokenProperties.InvalidReason
Output only. Reason associated with the response when valid = false.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp corresponding to the generation of the token.
hostname str
Output only. The hostname of the page on which the token was generated (Web keys only).
android_package_name str
Output only. The name of the Android package with which the token was generated (Android keys only).
ios_bundle_id str
Output only. The ID of the iOS bundle with which the token was generated (iOS keys only).
action str
Output only. Action name provided at token generation.

Classes

InvalidReason

InvalidReason(value)

Enum that represents the types of invalid token reasons. Ensure that applications can handle values not explicitly listed.

    - your `site_key` has the POLICY_BASED_CHALLENGE
      integration type
    - you set an action score threshold higher than 0.0
    - you provided a non-empty `expected_action`
KEY_MISMATCH (8):
    The key used to generate the token does not match the
    `site_key`.
DOMAIN_MISMATCH (9):
    The domain of the page on which the token was generated does
    not match the `allowed_domains` configured in the
    `site_key`.