Class: Google::Cloud::RecaptchaEnterprise::V1::TokenProperties

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

Overview

Properties of the provided event token.

Defined Under Namespace

Modules: InvalidReason

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::String (readonly)

Returns Output only. Action name provided at token generation.

Returns:

  • (::String) —

    Output only. Action name provided at token generation.



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#android_package_name ⇒ ::String (readonly)

Returns Output only. The name of the Android package with which the token was generated (Android keys only).

Returns:

  • (::String) —

    Output only. The name of the Android package with which the token was generated (Android keys only).



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp corresponding to the generation of the token.

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#hostname ⇒ ::String (readonly)

Returns Output only. The hostname of the page on which the token was generated (Web keys only).

Returns:

  • (::String) —

    Output only. The hostname of the page on which the token was generated (Web keys only).



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#invalid_reason ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason (readonly)

Returns Output only. Reason associated with the response when valid = false.

Returns:



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#ios_bundle_id ⇒ ::String (readonly)

Returns Output only. The ID of the iOS bundle with which the token was generated (iOS keys only).

Returns:

  • (::String) —

    Output only. The ID of the iOS bundle with which the token was generated (iOS keys only).



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end

#valid ⇒ ::Boolean (readonly)

Returns 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).

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).



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 778

class TokenProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of invalid token reasons.
  module InvalidReason
    # Default unspecified type.
    INVALID_REASON_UNSPECIFIED = 0

    # If the failure reason was not accounted for.
    UNKNOWN_INVALID_REASON = 1

    # The provided user verification token was malformed.
    MALFORMED = 2

    # The user verification token had expired.
    EXPIRED = 3

    # The user verification had already been seen.
    DUPE = 4

    # The user verification token was not present.
    MISSING = 5

    # A retriable error (such as network failure) occurred on the browser.
    # Could easily be simulated by an attacker.
    BROWSER_ERROR = 6
  end
end