reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::TokenProperties (v1.8.0)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::TokenProperties.

Properties of the provided event token.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String
Returns
  • (::String) — Output only. Action name provided at token generation.

#android_package_name

def android_package_name() -> ::String
Returns
  • (::String) — Output only. The name of the Android package with which the token was generated (Android keys only).

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#hostname

def hostname() -> ::String
Returns
  • (::String) — Output only. The hostname of the page on which the token was generated (Web keys only).

#invalid_reason

def invalid_reason() -> ::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason
Returns

#ios_bundle_id

def ios_bundle_id() -> ::String
Returns
  • (::String) — Output only. The ID of the iOS bundle with which the token was generated (iOS keys only).

#valid

def valid() -> ::Boolean
Returns
  • (::Boolean) — Output only. 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).