Class: Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo

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

Overview

Information about account verification, used for identity verification.

Defined Under Namespace

Modules: Result

Instance Attribute Summary collapse

Instance Attribute Details

#endpoints ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1::EndpointVerificationInfo>

Returns Optional. Endpoints that can be used for identity verification.

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 321

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

  # Result of the account verification as contained in the verdict token issued
  # at the end of the verification flow.
  module Result
    # No information about the latest account verification.
    RESULT_UNSPECIFIED = 0

    # The user was successfully verified. This means the account verification
    # challenge was successfully completed.
    SUCCESS_USER_VERIFIED = 1

    # The user failed the verification challenge.
    ERROR_USER_NOT_VERIFIED = 2

    # The site is not properly onboarded to use the account verification
    # feature.
    ERROR_SITE_ONBOARDING_INCOMPLETE = 3

    # The recipient is not allowed for account verification. This can occur
    # during integration but should not occur in production.
    ERROR_RECIPIENT_NOT_ALLOWED = 4

    # The recipient has already been sent too many verification codes in a
    # short amount of time.
    ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5

    # The verification flow could not be completed due to a critical internal
    # error.
    ERROR_CRITICAL_INTERNAL = 6

    # The client has exceeded their two factor request quota for this period of
    # time.
    ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7

    # The request cannot be processed at the time because of an incident. This
    # bypass can be restricted to a problematic destination email domain, a
    # customer, or could affect the entire service.
    ERROR_VERIFICATION_BYPASSED = 8

    # The request parameters do not match with the token provided and cannot be
    # processed.
    ERROR_VERDICT_MISMATCH = 9
  end
end

#language_code ⇒ ::String

Returns Optional. Language code preference for the verification message, set as a IETF BCP 47 language code.

Returns:

  • (::String) —

    Optional. Language code preference for the verification message, set as a IETF BCP 47 language code.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 321

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

  # Result of the account verification as contained in the verdict token issued
  # at the end of the verification flow.
  module Result
    # No information about the latest account verification.
    RESULT_UNSPECIFIED = 0

    # The user was successfully verified. This means the account verification
    # challenge was successfully completed.
    SUCCESS_USER_VERIFIED = 1

    # The user failed the verification challenge.
    ERROR_USER_NOT_VERIFIED = 2

    # The site is not properly onboarded to use the account verification
    # feature.
    ERROR_SITE_ONBOARDING_INCOMPLETE = 3

    # The recipient is not allowed for account verification. This can occur
    # during integration but should not occur in production.
    ERROR_RECIPIENT_NOT_ALLOWED = 4

    # The recipient has already been sent too many verification codes in a
    # short amount of time.
    ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5

    # The verification flow could not be completed due to a critical internal
    # error.
    ERROR_CRITICAL_INTERNAL = 6

    # The client has exceeded their two factor request quota for this period of
    # time.
    ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7

    # The request cannot be processed at the time because of an incident. This
    # bypass can be restricted to a problematic destination email domain, a
    # customer, or could affect the entire service.
    ERROR_VERIFICATION_BYPASSED = 8

    # The request parameters do not match with the token provided and cannot be
    # processed.
    ERROR_VERDICT_MISMATCH = 9
  end
end

#latest_verification_result ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo::Result (readonly)

Returns Output only. Result of the latest account verification challenge.

Returns:



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 321

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

  # Result of the account verification as contained in the verdict token issued
  # at the end of the verification flow.
  module Result
    # No information about the latest account verification.
    RESULT_UNSPECIFIED = 0

    # The user was successfully verified. This means the account verification
    # challenge was successfully completed.
    SUCCESS_USER_VERIFIED = 1

    # The user failed the verification challenge.
    ERROR_USER_NOT_VERIFIED = 2

    # The site is not properly onboarded to use the account verification
    # feature.
    ERROR_SITE_ONBOARDING_INCOMPLETE = 3

    # The recipient is not allowed for account verification. This can occur
    # during integration but should not occur in production.
    ERROR_RECIPIENT_NOT_ALLOWED = 4

    # The recipient has already been sent too many verification codes in a
    # short amount of time.
    ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5

    # The verification flow could not be completed due to a critical internal
    # error.
    ERROR_CRITICAL_INTERNAL = 6

    # The client has exceeded their two factor request quota for this period of
    # time.
    ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7

    # The request cannot be processed at the time because of an incident. This
    # bypass can be restricted to a problematic destination email domain, a
    # customer, or could affect the entire service.
    ERROR_VERIFICATION_BYPASSED = 8

    # The request parameters do not match with the token provided and cannot be
    # processed.
    ERROR_VERDICT_MISMATCH = 9
  end
end

#username ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Username of the account that is being verified. Deprecated. Customers should now provide the account_id field in event.user_info.

Returns:

  • (::String) —

    Username of the account that is being verified. Deprecated. Customers should now provide the account_id field in event.user_info.



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 321

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

  # Result of the account verification as contained in the verdict token issued
  # at the end of the verification flow.
  module Result
    # No information about the latest account verification.
    RESULT_UNSPECIFIED = 0

    # The user was successfully verified. This means the account verification
    # challenge was successfully completed.
    SUCCESS_USER_VERIFIED = 1

    # The user failed the verification challenge.
    ERROR_USER_NOT_VERIFIED = 2

    # The site is not properly onboarded to use the account verification
    # feature.
    ERROR_SITE_ONBOARDING_INCOMPLETE = 3

    # The recipient is not allowed for account verification. This can occur
    # during integration but should not occur in production.
    ERROR_RECIPIENT_NOT_ALLOWED = 4

    # The recipient has already been sent too many verification codes in a
    # short amount of time.
    ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5

    # The verification flow could not be completed due to a critical internal
    # error.
    ERROR_CRITICAL_INTERNAL = 6

    # The client has exceeded their two factor request quota for this period of
    # time.
    ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7

    # The request cannot be processed at the time because of an incident. This
    # bypass can be restricted to a problematic destination email domain, a
    # customer, or could affect the entire service.
    ERROR_VERIFICATION_BYPASSED = 8

    # The request parameters do not match with the token provided and cannot be
    # processed.
    ERROR_VERDICT_MISMATCH = 9
  end
end