google-cloud-recaptcha_enterprise-v1beta1 0.4.5 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/client.rb +12 -494
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/paths.rb +0 -17
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/version.rb +1 -1
- data/lib/google/cloud/recaptcha_enterprise/v1beta1.rb +2 -0
- data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb +39 -70
- data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_services_pb.rb +1 -12
- data/proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb +130 -177
- metadata +3 -5
- data/proto_docs/google/protobuf/empty.rb +0 -36
- data/proto_docs/google/protobuf/field_mask.rb +0 -229
@@ -1,14 +1,13 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto
|
3
3
|
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
4
6
|
require 'google/api/annotations_pb'
|
5
7
|
require 'google/api/client_pb'
|
6
8
|
require 'google/api/field_behavior_pb'
|
7
9
|
require 'google/api/resource_pb'
|
8
|
-
require 'google/protobuf/empty_pb'
|
9
|
-
require 'google/protobuf/field_mask_pb'
|
10
10
|
require 'google/protobuf/timestamp_pb'
|
11
|
-
require 'google/protobuf'
|
12
11
|
|
13
12
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
13
|
add_file("google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto", :syntax => :proto3) do
|
@@ -19,20 +18,43 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
19
18
|
add_message "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest" do
|
20
19
|
optional :name, :string, 1
|
21
20
|
optional :annotation, :enum, 2, "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation"
|
21
|
+
repeated :reasons, :enum, 3, "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Reason"
|
22
|
+
optional :hashed_account_id, :bytes, 4
|
22
23
|
end
|
23
24
|
add_enum "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation" do
|
24
25
|
value :ANNOTATION_UNSPECIFIED, 0
|
25
26
|
value :LEGITIMATE, 1
|
26
27
|
value :FRAUDULENT, 2
|
28
|
+
value :PASSWORD_CORRECT, 3
|
29
|
+
value :PASSWORD_INCORRECT, 4
|
30
|
+
end
|
31
|
+
add_enum "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Reason" do
|
32
|
+
value :REASON_UNSPECIFIED, 0
|
33
|
+
value :CHARGEBACK, 1
|
34
|
+
value :CHARGEBACK_FRAUD, 8
|
35
|
+
value :CHARGEBACK_DISPUTE, 9
|
36
|
+
value :PAYMENT_HEURISTICS, 2
|
37
|
+
value :INITIATED_TWO_FACTOR, 7
|
38
|
+
value :PASSED_TWO_FACTOR, 3
|
39
|
+
value :FAILED_TWO_FACTOR, 4
|
40
|
+
value :CORRECT_PASSWORD, 5
|
41
|
+
value :INCORRECT_PASSWORD, 6
|
27
42
|
end
|
28
43
|
add_message "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse" do
|
29
44
|
end
|
45
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification" do
|
46
|
+
optional :hashed_user_credentials, :bytes, 1
|
47
|
+
optional :credentials_leaked, :bool, 2
|
48
|
+
optional :canonicalized_username, :string, 3
|
49
|
+
end
|
30
50
|
add_message "google.cloud.recaptchaenterprise.v1beta1.Assessment" do
|
31
51
|
optional :name, :string, 1
|
32
52
|
optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1beta1.Event"
|
33
53
|
optional :score, :float, 3
|
34
54
|
optional :token_properties, :message, 4, "google.cloud.recaptchaenterprise.v1beta1.TokenProperties"
|
35
55
|
repeated :reasons, :enum, 5, "google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason"
|
56
|
+
optional :password_leak_verification, :message, 7, "google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification"
|
57
|
+
optional :account_defender_assessment, :message, 8, "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment"
|
36
58
|
end
|
37
59
|
add_enum "google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason" do
|
38
60
|
value :CLASSIFICATION_REASON_UNSPECIFIED, 0
|
@@ -48,6 +70,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
48
70
|
optional :user_agent, :string, 3
|
49
71
|
optional :user_ip_address, :string, 4
|
50
72
|
optional :expected_action, :string, 5
|
73
|
+
optional :hashed_account_id, :bytes, 6
|
51
74
|
end
|
52
75
|
add_message "google.cloud.recaptchaenterprise.v1beta1.TokenProperties" do
|
53
76
|
optional :valid, :bool, 1
|
@@ -64,63 +87,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
64
87
|
value :DUPE, 4
|
65
88
|
value :SITE_MISMATCH, 5
|
66
89
|
value :MISSING, 6
|
90
|
+
value :BROWSER_ERROR, 7
|
67
91
|
end
|
68
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.
|
69
|
-
|
70
|
-
optional :key, :message, 2, "google.cloud.recaptchaenterprise.v1beta1.Key"
|
71
|
-
end
|
72
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.ListKeysRequest" do
|
73
|
-
optional :parent, :string, 1
|
74
|
-
optional :page_size, :int32, 2
|
75
|
-
optional :page_token, :string, 3
|
76
|
-
end
|
77
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse" do
|
78
|
-
repeated :keys, :message, 1, "google.cloud.recaptchaenterprise.v1beta1.Key"
|
79
|
-
optional :next_page_token, :string, 2
|
80
|
-
end
|
81
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.GetKeyRequest" do
|
82
|
-
optional :name, :string, 1
|
83
|
-
end
|
84
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest" do
|
85
|
-
optional :key, :message, 1, "google.cloud.recaptchaenterprise.v1beta1.Key"
|
86
|
-
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
87
|
-
end
|
88
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.DeleteKeyRequest" do
|
89
|
-
optional :name, :string, 1
|
90
|
-
end
|
91
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.Key" do
|
92
|
-
optional :name, :string, 1
|
93
|
-
optional :display_name, :string, 2
|
94
|
-
oneof :platform_settings do
|
95
|
-
optional :web_settings, :message, 3, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings"
|
96
|
-
optional :android_settings, :message, 4, "google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings"
|
97
|
-
optional :ios_settings, :message, 5, "google.cloud.recaptchaenterprise.v1beta1.IOSKeySettings"
|
98
|
-
end
|
99
|
-
end
|
100
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings" do
|
101
|
-
optional :enforce_allowed_domains, :bool, 3
|
102
|
-
repeated :allowed_domains, :string, 1
|
103
|
-
optional :allow_amp_traffic, :bool, 2
|
104
|
-
optional :integration_type, :enum, 4, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType"
|
105
|
-
optional :challenge_security_preference, :enum, 5, "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference"
|
106
|
-
end
|
107
|
-
add_enum "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType" do
|
108
|
-
value :INTEGRATION_TYPE_UNSPECIFIED, 0
|
109
|
-
value :SCORE_ONLY, 1
|
110
|
-
value :CHECKBOX_CHALLENGE, 2
|
111
|
-
value :INVISIBLE_CHALLENGE, 3
|
112
|
-
end
|
113
|
-
add_enum "google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference" do
|
114
|
-
value :CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, 0
|
115
|
-
value :USABILITY, 1
|
116
|
-
value :BALANCED, 2
|
117
|
-
value :SECURITY, 3
|
118
|
-
end
|
119
|
-
add_message "google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings" do
|
120
|
-
repeated :allowed_package_names, :string, 1
|
92
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment" do
|
93
|
+
repeated :labels, :enum, 1, "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel"
|
121
94
|
end
|
122
|
-
|
123
|
-
|
95
|
+
add_enum "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel" do
|
96
|
+
value :ACCOUNT_DEFENDER_LABEL_UNSPECIFIED, 0
|
97
|
+
value :PROFILE_MATCH, 1
|
98
|
+
value :SUSPICIOUS_LOGIN_ACTIVITY, 2
|
99
|
+
value :SUSPICIOUS_ACCOUNT_CREATION, 3
|
100
|
+
value :RELATED_ACCOUNTS_NUMBER_HIGH, 4
|
124
101
|
end
|
125
102
|
end
|
126
103
|
end
|
@@ -132,24 +109,16 @@ module Google
|
|
132
109
|
CreateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.CreateAssessmentRequest").msgclass
|
133
110
|
AnnotateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest").msgclass
|
134
111
|
AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation").enummodule
|
112
|
+
AnnotateAssessmentRequest::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Reason").enummodule
|
135
113
|
AnnotateAssessmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse").msgclass
|
114
|
+
PasswordLeakVerification = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification").msgclass
|
136
115
|
Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Assessment").msgclass
|
137
116
|
Assessment::ClassificationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason").enummodule
|
138
117
|
Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Event").msgclass
|
139
118
|
TokenProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties").msgclass
|
140
119
|
TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties.InvalidReason").enummodule
|
141
|
-
|
142
|
-
|
143
|
-
ListKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse").msgclass
|
144
|
-
GetKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.GetKeyRequest").msgclass
|
145
|
-
UpdateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.UpdateKeyRequest").msgclass
|
146
|
-
DeleteKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.DeleteKeyRequest").msgclass
|
147
|
-
Key = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Key").msgclass
|
148
|
-
WebKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings").msgclass
|
149
|
-
WebKeySettings::IntegrationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.IntegrationType").enummodule
|
150
|
-
WebKeySettings::ChallengeSecurityPreference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.WebKeySettings.ChallengeSecurityPreference").enummodule
|
151
|
-
AndroidKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AndroidKeySettings").msgclass
|
152
|
-
IOSKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.IOSKeySettings").msgclass
|
120
|
+
AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment").msgclass
|
121
|
+
AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
|
153
122
|
end
|
154
123
|
end
|
155
124
|
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# Source: google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto for package 'Google.Cloud.RecaptchaEnterprise.V1beta1'
|
3
3
|
# Original file comments:
|
4
|
-
# Copyright
|
4
|
+
# Copyright 2022 Google LLC
|
5
5
|
#
|
6
6
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
7
|
# you may not use this file except in compliance with the License.
|
@@ -15,7 +15,6 @@
|
|
15
15
|
# See the License for the specific language governing permissions and
|
16
16
|
# limitations under the License.
|
17
17
|
#
|
18
|
-
#
|
19
18
|
|
20
19
|
require 'grpc'
|
21
20
|
require 'google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb'
|
@@ -39,16 +38,6 @@ module Google
|
|
39
38
|
# Annotates a previously created Assessment to provide additional information
|
40
39
|
# on whether the event turned out to be authentic or fradulent.
|
41
40
|
rpc :AnnotateAssessment, ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest, ::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentResponse
|
42
|
-
# Creates a new reCAPTCHA Enterprise key.
|
43
|
-
rpc :CreateKey, ::Google::Cloud::RecaptchaEnterprise::V1beta1::CreateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1beta1::Key
|
44
|
-
# Returns the list of all keys that belong to a project.
|
45
|
-
rpc :ListKeys, ::Google::Cloud::RecaptchaEnterprise::V1beta1::ListKeysRequest, ::Google::Cloud::RecaptchaEnterprise::V1beta1::ListKeysResponse
|
46
|
-
# Returns the specified key.
|
47
|
-
rpc :GetKey, ::Google::Cloud::RecaptchaEnterprise::V1beta1::GetKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1beta1::Key
|
48
|
-
# Updates the specified key.
|
49
|
-
rpc :UpdateKey, ::Google::Cloud::RecaptchaEnterprise::V1beta1::UpdateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1beta1::Key
|
50
|
-
# Deletes the specified key.
|
51
|
-
rpc :DeleteKey, ::Google::Cloud::RecaptchaEnterprise::V1beta1::DeleteKeyRequest, ::Google::Protobuf::Empty
|
52
41
|
end
|
53
42
|
|
54
43
|
Stub = Service.rpc_stub_class
|
@@ -41,12 +41,24 @@ module Google
|
|
41
41
|
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
42
42
|
# @!attribute [rw] annotation
|
43
43
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
|
44
|
-
#
|
44
|
+
# Optional. The annotation that will be assigned to the Event. This field can be left
|
45
|
+
# empty to provide reasons that apply to an event without concluding whether
|
46
|
+
# the event is legitimate or fraudulent.
|
47
|
+
# @!attribute [rw] reasons
|
48
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
|
49
|
+
# Optional. Optional reasons for the annotation that will be assigned to the Event.
|
50
|
+
# @!attribute [rw] hashed_account_id
|
51
|
+
# @return [::String]
|
52
|
+
# Optional. Optional unique stable hashed user identifier to apply to the assessment.
|
53
|
+
# This is an alternative to setting the hashed_account_id in
|
54
|
+
# CreateAssessment, for example when the account identifier is not yet known
|
55
|
+
# in the initial request. It is recommended that the identifier is hashed
|
56
|
+
# using hmac-sha256 with stable secret.
|
45
57
|
class AnnotateAssessmentRequest
|
46
58
|
include ::Google::Protobuf::MessageExts
|
47
59
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
48
60
|
|
49
|
-
# Enum that
|
61
|
+
# Enum that represents the types of annotations.
|
50
62
|
module Annotation
|
51
63
|
# Default unspecified type.
|
52
64
|
ANNOTATION_UNSPECIFIED = 0
|
@@ -56,6 +68,60 @@ module Google
|
|
56
68
|
|
57
69
|
# Provides information that the event turned out to be fraudulent.
|
58
70
|
FRAUDULENT = 2
|
71
|
+
|
72
|
+
# Provides information that the event was related to a login event in which
|
73
|
+
# the user typed the correct password. Deprecated, prefer indicating
|
74
|
+
# CORRECT_PASSWORD through the reasons field instead.
|
75
|
+
PASSWORD_CORRECT = 3
|
76
|
+
|
77
|
+
# Provides information that the event was related to a login event in which
|
78
|
+
# the user typed the incorrect password. Deprecated, prefer indicating
|
79
|
+
# INCORRECT_PASSWORD through the reasons field instead.
|
80
|
+
PASSWORD_INCORRECT = 4
|
81
|
+
end
|
82
|
+
|
83
|
+
# Enum that represents potential reasons for annotating an assessment.
|
84
|
+
module Reason
|
85
|
+
# Default unspecified reason.
|
86
|
+
REASON_UNSPECIFIED = 0
|
87
|
+
|
88
|
+
# Indicates a chargeback issued for the transaction with no other details.
|
89
|
+
# When possible, specify the type by using CHARGEBACK_FRAUD or
|
90
|
+
# CHARGEBACK_DISPUTE instead.
|
91
|
+
CHARGEBACK = 1
|
92
|
+
|
93
|
+
# Indicates a chargeback related to an alleged unauthorized transaction
|
94
|
+
# from the cardholder's perspective (for example, the card number was
|
95
|
+
# stolen).
|
96
|
+
CHARGEBACK_FRAUD = 8
|
97
|
+
|
98
|
+
# Indicates a chargeback related to the cardholder having provided their
|
99
|
+
# card details but allegedly not being satisfied with the purchase
|
100
|
+
# (for example, misrepresentation, attempted cancellation).
|
101
|
+
CHARGEBACK_DISPUTE = 9
|
102
|
+
|
103
|
+
# Indicates the transaction associated with the assessment is suspected of
|
104
|
+
# being fraudulent based on the payment method, billing details, shipping
|
105
|
+
# address or other transaction information.
|
106
|
+
PAYMENT_HEURISTICS = 2
|
107
|
+
|
108
|
+
# Indicates that the user was served a 2FA challenge. An old assessment
|
109
|
+
# with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
|
110
|
+
# overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
|
111
|
+
# This is equivalent to `FAILED_TWO_FACTOR`.
|
112
|
+
INITIATED_TWO_FACTOR = 7
|
113
|
+
|
114
|
+
# Indicates that the user passed a 2FA challenge.
|
115
|
+
PASSED_TWO_FACTOR = 3
|
116
|
+
|
117
|
+
# Indicates that the user failed a 2FA challenge.
|
118
|
+
FAILED_TWO_FACTOR = 4
|
119
|
+
|
120
|
+
# Indicates the user provided the correct password.
|
121
|
+
CORRECT_PASSWORD = 5
|
122
|
+
|
123
|
+
# Indicates the user provided an incorrect password.
|
124
|
+
INCORRECT_PASSWORD = 6
|
59
125
|
end
|
60
126
|
end
|
61
127
|
|
@@ -65,6 +131,24 @@ module Google
|
|
65
131
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
66
132
|
end
|
67
133
|
|
134
|
+
# Password leak verification info.
|
135
|
+
# @!attribute [rw] hashed_user_credentials
|
136
|
+
# @return [::String]
|
137
|
+
# Optional. Scrypt hash of the username+password that the customer wants to verify
|
138
|
+
# against a known password leak.
|
139
|
+
# @!attribute [r] credentials_leaked
|
140
|
+
# @return [::Boolean]
|
141
|
+
# Output only. Whether or not the user's credentials are present in a known leak.
|
142
|
+
# @!attribute [rw] canonicalized_username
|
143
|
+
# @return [::String]
|
144
|
+
# Optional. The username part of the user credentials for which we want to trigger a
|
145
|
+
# leak check in canonicalized form. This is the same data used to create the
|
146
|
+
# hashed_user_credentials on the customer side.
|
147
|
+
class PasswordLeakVerification
|
148
|
+
include ::Google::Protobuf::MessageExts
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
150
|
+
end
|
151
|
+
|
68
152
|
# A recaptcha assessment resource.
|
69
153
|
# @!attribute [r] name
|
70
154
|
# @return [::String]
|
@@ -84,11 +168,20 @@ module Google
|
|
84
168
|
# @!attribute [r] reasons
|
85
169
|
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment::ClassificationReason>]
|
86
170
|
# Output only. Reasons contributing to the risk analysis verdict.
|
171
|
+
# @!attribute [rw] password_leak_verification
|
172
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::PasswordLeakVerification]
|
173
|
+
# Information about the user's credentials used to check for leaks.
|
174
|
+
# This feature is part of the Early Access Program (EAP). Exercise caution,
|
175
|
+
# and do not deploy integrations based on this feature in a production
|
176
|
+
# environment.
|
177
|
+
# @!attribute [rw] account_defender_assessment
|
178
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AccountDefenderAssessment]
|
179
|
+
# Assessment returned by Account Defender when a hashed_account_id is
|
180
|
+
# provided.
|
87
181
|
class Assessment
|
88
182
|
include ::Google::Protobuf::MessageExts
|
89
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
184
|
|
91
|
-
# LINT.IfChange(classification_reason)
|
92
185
|
# Reasons contributing to the risk analysis verdict.
|
93
186
|
module ClassificationReason
|
94
187
|
# Default unspecified type.
|
@@ -133,6 +226,10 @@ module Google
|
|
133
226
|
# Optional. The expected action for this type of event. This should be the same action
|
134
227
|
# provided at token generation time on client-side platforms already
|
135
228
|
# integrated with recaptcha enterprise.
|
229
|
+
# @!attribute [rw] hashed_account_id
|
230
|
+
# @return [::String]
|
231
|
+
# Optional. Optional unique stable hashed user identifier for the request. The
|
232
|
+
# identifier should ideally be hashed using sha256 with stable secret.
|
136
233
|
class Event
|
137
234
|
include ::Google::Protobuf::MessageExts
|
138
235
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -140,7 +237,11 @@ module Google
|
|
140
237
|
|
141
238
|
# @!attribute [rw] valid
|
142
239
|
# @return [::Boolean]
|
143
|
-
# Whether the provided user response token is valid.
|
240
|
+
# Whether the provided user response token is valid. When valid = false, the
|
241
|
+
# reason could be specified in invalid_reason or it could also be due to
|
242
|
+
# a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
|
243
|
+
# used to generate the token was different than the one specified in the
|
244
|
+
# assessment).
|
144
245
|
# @!attribute [rw] invalid_reason
|
145
246
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties::InvalidReason]
|
146
247
|
# Reason associated with the response when valid = false.
|
@@ -157,7 +258,6 @@ module Google
|
|
157
258
|
include ::Google::Protobuf::MessageExts
|
158
259
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
159
260
|
|
160
|
-
# LINT.IfChange
|
161
261
|
# Enum that represents the types of invalid token reasons.
|
162
262
|
module InvalidReason
|
163
263
|
# Default unspecified type.
|
@@ -183,190 +283,43 @@ module Google
|
|
183
283
|
|
184
284
|
# The user verification token was not present. It is a required input.
|
185
285
|
MISSING = 6
|
186
|
-
end
|
187
|
-
end
|
188
|
-
|
189
|
-
# The create key request message.
|
190
|
-
# @!attribute [rw] parent
|
191
|
-
# @return [::String]
|
192
|
-
# Required. The name of the project in which the key will be created, in the
|
193
|
-
# format "projects/\\{project_number}".
|
194
|
-
# @!attribute [rw] key
|
195
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
|
196
|
-
# Required. Information to create a reCAPTCHA Enterprise key.
|
197
|
-
class CreateKeyRequest
|
198
|
-
include ::Google::Protobuf::MessageExts
|
199
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
-
end
|
201
286
|
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
# listed, in the format "projects/\\{project_number}".
|
207
|
-
# @!attribute [rw] page_size
|
208
|
-
# @return [::Integer]
|
209
|
-
# Optional. The maximum number of keys to return. Default is 10. Max limit is
|
210
|
-
# 1000.
|
211
|
-
# @!attribute [rw] page_token
|
212
|
-
# @return [::String]
|
213
|
-
# Optional. The next_page_token value returned from a previous.
|
214
|
-
# ListKeysRequest, if any.
|
215
|
-
class ListKeysRequest
|
216
|
-
include ::Google::Protobuf::MessageExts
|
217
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
-
end
|
219
|
-
|
220
|
-
# Response to request to list keys in a project.
|
221
|
-
# @!attribute [rw] keys
|
222
|
-
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::Key>]
|
223
|
-
# Key details.
|
224
|
-
# @!attribute [rw] next_page_token
|
225
|
-
# @return [::String]
|
226
|
-
# Token to retrieve the next page of results. It is set to empty if no keys
|
227
|
-
# remain in results.
|
228
|
-
class ListKeysResponse
|
229
|
-
include ::Google::Protobuf::MessageExts
|
230
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
231
|
-
end
|
232
|
-
|
233
|
-
# The get key request message.
|
234
|
-
# @!attribute [rw] name
|
235
|
-
# @return [::String]
|
236
|
-
# Required. The name of the requested key, in the format
|
237
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
238
|
-
class GetKeyRequest
|
239
|
-
include ::Google::Protobuf::MessageExts
|
240
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
241
|
-
end
|
242
|
-
|
243
|
-
# The update key request message.
|
244
|
-
# @!attribute [rw] key
|
245
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
|
246
|
-
# Required. The key to update.
|
247
|
-
# @!attribute [rw] update_mask
|
248
|
-
# @return [::Google::Protobuf::FieldMask]
|
249
|
-
# Optional. The mask to control which field of the key get updated. If the mask is not
|
250
|
-
# present, all fields will be updated.
|
251
|
-
class UpdateKeyRequest
|
252
|
-
include ::Google::Protobuf::MessageExts
|
253
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
254
|
-
end
|
255
|
-
|
256
|
-
# The delete key request message.
|
257
|
-
# @!attribute [rw] name
|
258
|
-
# @return [::String]
|
259
|
-
# Required. The name of the key to be deleted, in the format
|
260
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
261
|
-
class DeleteKeyRequest
|
262
|
-
include ::Google::Protobuf::MessageExts
|
263
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
264
|
-
end
|
265
|
-
|
266
|
-
# A key used to identify and configure applications (web and/or mobile) that
|
267
|
-
# use reCAPTCHA Enterprise.
|
268
|
-
# @!attribute [rw] name
|
269
|
-
# @return [::String]
|
270
|
-
# The resource name for the Key in the format
|
271
|
-
# "projects/\\{project_number}/keys/\\{key_id}".
|
272
|
-
# @!attribute [rw] display_name
|
273
|
-
# @return [::String]
|
274
|
-
# Human-readable display name of this key. Modifiable by user.
|
275
|
-
# @!attribute [rw] web_settings
|
276
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings]
|
277
|
-
# Settings for keys that can be used by websites.
|
278
|
-
# @!attribute [rw] android_settings
|
279
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AndroidKeySettings]
|
280
|
-
# Settings for keys that can be used by Android apps.
|
281
|
-
# @!attribute [rw] ios_settings
|
282
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::IOSKeySettings]
|
283
|
-
# Settings for keys that can be used by iOS apps.
|
284
|
-
class Key
|
285
|
-
include ::Google::Protobuf::MessageExts
|
286
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
287
|
+
# A retriable error (such as network failure) occurred on the browser.
|
288
|
+
# Could easily be simulated by an attacker.
|
289
|
+
BROWSER_ERROR = 7
|
290
|
+
end
|
287
291
|
end
|
288
292
|
|
289
|
-
#
|
290
|
-
# @!attribute [rw]
|
291
|
-
# @return [::
|
292
|
-
#
|
293
|
-
|
294
|
-
# @return [::Array<::String>]
|
295
|
-
# Domains or subdomains of websites allowed to use the key. All subdomains
|
296
|
-
# of an allowed domain are automatically allowed. A valid domain requires a
|
297
|
-
# host and must not include any path, port, query or fragment.
|
298
|
-
# Examples: 'example.com' or 'subdomain.example.com'
|
299
|
-
# @!attribute [rw] allow_amp_traffic
|
300
|
-
# @return [::Boolean]
|
301
|
-
# Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
|
302
|
-
# @!attribute [rw] integration_type
|
303
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType]
|
304
|
-
# Required. Describes how this key is integrated with the website.
|
305
|
-
# @!attribute [rw] challenge_security_preference
|
306
|
-
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference]
|
307
|
-
# Settings for the frequency and difficulty at which this key triggers
|
308
|
-
# captcha challenges. This should only be specified for IntegrationTypes
|
309
|
-
# CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
|
310
|
-
class WebKeySettings
|
293
|
+
# Account Defender risk assessment.
|
294
|
+
# @!attribute [rw] labels
|
295
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AccountDefenderAssessment::AccountDefenderLabel>]
|
296
|
+
# Labels for this request.
|
297
|
+
class AccountDefenderAssessment
|
311
298
|
include ::Google::Protobuf::MessageExts
|
312
299
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
313
300
|
|
314
|
-
#
|
315
|
-
module
|
316
|
-
# Default type
|
317
|
-
|
318
|
-
# instead.
|
319
|
-
INTEGRATION_TYPE_UNSPECIFIED = 0
|
320
|
-
|
321
|
-
# Only used to produce scores. It doesn't display the "I'm not a robot"
|
322
|
-
# checkbox and never shows captcha challenges.
|
323
|
-
SCORE_ONLY = 1
|
324
|
-
|
325
|
-
# Displays the "I'm not a robot" checkbox and may show captcha challenges
|
326
|
-
# after it is checked.
|
327
|
-
CHECKBOX_CHALLENGE = 2
|
328
|
-
|
329
|
-
# Doesn't display the "I'm not a robot" checkbox, but may show captcha
|
330
|
-
# challenges after risk analysis.
|
331
|
-
INVISIBLE_CHALLENGE = 3
|
332
|
-
end
|
301
|
+
# Labels returned by Account Defender for this request.
|
302
|
+
module AccountDefenderLabel
|
303
|
+
# Default unspecified type.
|
304
|
+
ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0
|
333
305
|
|
334
|
-
|
335
|
-
|
336
|
-
module ChallengeSecurityPreference
|
337
|
-
# Default type that indicates this enum hasn't been specified.
|
338
|
-
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
|
306
|
+
# The request matches a known good profile for the user.
|
307
|
+
PROFILE_MATCH = 1
|
339
308
|
|
340
|
-
#
|
341
|
-
|
309
|
+
# The request is potentially a suspicious login event and should be further
|
310
|
+
# verified either via multi-factor authentication or another system.
|
311
|
+
SUSPICIOUS_LOGIN_ACTIVITY = 2
|
342
312
|
|
343
|
-
#
|
344
|
-
|
313
|
+
# The request matched a profile that previously had suspicious account
|
314
|
+
# creation behavior. This could mean this is a fake account.
|
315
|
+
SUSPICIOUS_ACCOUNT_CREATION = 3
|
345
316
|
|
346
|
-
#
|
347
|
-
|
317
|
+
# The account in the request has a high number of related accounts. It does
|
318
|
+
# not necessarily imply that the account is bad but could require
|
319
|
+
# investigating.
|
320
|
+
RELATED_ACCOUNTS_NUMBER_HIGH = 4
|
348
321
|
end
|
349
322
|
end
|
350
|
-
|
351
|
-
# Settings specific to keys that can be used by Android apps.
|
352
|
-
# @!attribute [rw] allowed_package_names
|
353
|
-
# @return [::Array<::String>]
|
354
|
-
# Android package names of apps allowed to use the key.
|
355
|
-
# Example: 'com.companyname.appname'
|
356
|
-
class AndroidKeySettings
|
357
|
-
include ::Google::Protobuf::MessageExts
|
358
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
359
|
-
end
|
360
|
-
|
361
|
-
# Settings specific to keys that can be used by iOS apps.
|
362
|
-
# @!attribute [rw] allowed_bundle_ids
|
363
|
-
# @return [::Array<::String>]
|
364
|
-
# iOS bundle ids of apps allowed to use the key.
|
365
|
-
# Example: 'com.companyname.productname.appname'
|
366
|
-
class IOSKeySettings
|
367
|
-
include ::Google::Protobuf::MessageExts
|
368
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
369
|
-
end
|
370
323
|
end
|
371
324
|
end
|
372
325
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-recaptcha_enterprise-v1beta1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-05-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -182,8 +182,6 @@ files:
|
|
182
182
|
- proto_docs/google/api/field_behavior.rb
|
183
183
|
- proto_docs/google/api/resource.rb
|
184
184
|
- proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb
|
185
|
-
- proto_docs/google/protobuf/empty.rb
|
186
|
-
- proto_docs/google/protobuf/field_mask.rb
|
187
185
|
- proto_docs/google/protobuf/timestamp.rb
|
188
186
|
homepage: https://github.com/googleapis/google-cloud-ruby
|
189
187
|
licenses:
|
@@ -204,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
204
202
|
- !ruby/object:Gem::Version
|
205
203
|
version: '0'
|
206
204
|
requirements: []
|
207
|
-
rubygems_version: 3.3.
|
205
|
+
rubygems_version: 3.3.5
|
208
206
|
signing_key:
|
209
207
|
specification_version: 4
|
210
208
|
summary: API Client library for the reCAPTCHA Enterprise V1beta1 API
|
@@ -1,36 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
# Copyright 2020 Google LLC
|
4
|
-
#
|
5
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
-
# you may not use this file except in compliance with the License.
|
7
|
-
# You may obtain a copy of the License at
|
8
|
-
#
|
9
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
-
#
|
11
|
-
# Unless required by applicable law or agreed to in writing, software
|
12
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
-
# See the License for the specific language governing permissions and
|
15
|
-
# limitations under the License.
|
16
|
-
|
17
|
-
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
-
|
19
|
-
|
20
|
-
module Google
|
21
|
-
module Protobuf
|
22
|
-
# A generic empty message that you can re-use to avoid defining duplicated
|
23
|
-
# empty messages in your APIs. A typical example is to use it as the request
|
24
|
-
# or the response type of an API method. For instance:
|
25
|
-
#
|
26
|
-
# service Foo {
|
27
|
-
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
|
-
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
|
-
class Empty
|
32
|
-
include ::Google::Protobuf::MessageExts
|
33
|
-
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
|
-
end
|
35
|
-
end
|
36
|
-
end
|