Class: Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties

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

Defined Under Namespace

Modules: InvalidReason

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ ::String

Returns Action name provided at token generation.

Returns:

  • (::String) —

    Action name provided at token generation.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 156

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

  # LINT.IfChange
  # 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 did not match the provided site key.
    # This may be a configuration error (e.g. development keys used in
    # production) or end users trying to use verification tokens from other
    # sites.
    SITE_MISMATCH = 5

    # The user verification token was not present.  It is a required input.
    MISSING = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp corresponding to the generation of the token.

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 156

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

  # LINT.IfChange
  # 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 did not match the provided site key.
    # This may be a configuration error (e.g. development keys used in
    # production) or end users trying to use verification tokens from other
    # sites.
    SITE_MISMATCH = 5

    # The user verification token was not present.  It is a required input.
    MISSING = 6
  end
end

#hostname ⇒ ::String

Returns The hostname of the page on which the token was generated.

Returns:

  • (::String) —

    The hostname of the page on which the token was generated.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 156

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

  # LINT.IfChange
  # 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 did not match the provided site key.
    # This may be a configuration error (e.g. development keys used in
    # production) or end users trying to use verification tokens from other
    # sites.
    SITE_MISMATCH = 5

    # The user verification token was not present.  It is a required input.
    MISSING = 6
  end
end

#invalid_reason ⇒ ::Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties::InvalidReason

Returns Reason associated with the response when valid = false.

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 156

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

  # LINT.IfChange
  # 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 did not match the provided site key.
    # This may be a configuration error (e.g. development keys used in
    # production) or end users trying to use verification tokens from other
    # sites.
    SITE_MISMATCH = 5

    # The user verification token was not present.  It is a required input.
    MISSING = 6
  end
end

#valid ⇒ ::Boolean

Returns Whether the provided user response token is valid.

Returns:

  • (::Boolean) —

    Whether the provided user response token is valid.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb', line 156

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

  # LINT.IfChange
  # 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 did not match the provided site key.
    # This may be a configuration error (e.g. development keys used in
    # production) or end users trying to use verification tokens from other
    # sites.
    SITE_MISMATCH = 5

    # The user verification token was not present.  It is a required input.
    MISSING = 6
  end
end