google-cloud-recaptcha_enterprise-v1 0.4.3 → 0.7.1
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/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb +693 -25
- data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/paths.rb +34 -0
- data/lib/google/cloud/recaptcha_enterprise/v1/version.rb +1 -1
- data/lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_pb.rb +120 -2
- data/lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_services_pb.rb +18 -2
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb +398 -9
- metadata +3 -3
@@ -41,12 +41,24 @@ module Google
|
|
41
41
|
# "projects/\\{project}/assessments/\\{assessment}".
|
42
42
|
# @!attribute [rw] annotation
|
43
43
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::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::V1::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
|
@@ -58,13 +70,59 @@ module Google
|
|
58
70
|
FRAUDULENT = 2
|
59
71
|
|
60
72
|
# Provides information that the event was related to a login event in which
|
61
|
-
# the user typed the correct password.
|
73
|
+
# the user typed the correct password. Deprecated, prefer indicating
|
74
|
+
# CORRECT_PASSWORD through the reasons field instead.
|
62
75
|
PASSWORD_CORRECT = 3
|
63
76
|
|
64
77
|
# Provides information that the event was related to a login event in which
|
65
|
-
# the user typed the incorrect password.
|
78
|
+
# the user typed the incorrect password. Deprecated, prefer indicating
|
79
|
+
# INCORRECT_PASSWORD through the reasons field instead.
|
66
80
|
PASSWORD_INCORRECT = 4
|
67
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 was issued for the transaction associated with the
|
89
|
+
# assessment, with no other details. When possible, specify the type by
|
90
|
+
# using CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead.
|
91
|
+
CHARGEBACK = 1
|
92
|
+
|
93
|
+
# Indicates a chargeback related to an alleged unauthorized transaction
|
94
|
+
# from the perspective of the cardholder (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 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
|
125
|
+
end
|
68
126
|
end
|
69
127
|
|
70
128
|
# Empty response for AnnotateAssessment.
|
@@ -87,6 +145,10 @@ module Google
|
|
87
145
|
# @!attribute [r] token_properties
|
88
146
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties]
|
89
147
|
# Output only. Properties of the provided event token.
|
148
|
+
# @!attribute [rw] account_defender_assessment
|
149
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
|
150
|
+
# Assessment returned by Account Defender when a hashed_account_id is
|
151
|
+
# provided.
|
90
152
|
class Assessment
|
91
153
|
include ::Google::Protobuf::MessageExts
|
92
154
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -112,6 +174,10 @@ module Google
|
|
112
174
|
# Optional. The expected action for this type of event. This should be the same action
|
113
175
|
# provided at token generation time on client-side platforms already
|
114
176
|
# integrated with recaptcha enterprise.
|
177
|
+
# @!attribute [rw] hashed_account_id
|
178
|
+
# @return [::String]
|
179
|
+
# Optional. Optional unique stable hashed user identifier for the request. The
|
180
|
+
# identifier should ideally be hashed using sha256 with stable secret.
|
115
181
|
class Event
|
116
182
|
include ::Google::Protobuf::MessageExts
|
117
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -130,7 +196,6 @@ module Google
|
|
130
196
|
include ::Google::Protobuf::MessageExts
|
131
197
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
198
|
|
133
|
-
# LINT.IfChange(classification_reason)
|
134
199
|
# Reasons contributing to the risk analysis verdict.
|
135
200
|
module ClassificationReason
|
136
201
|
# Default unspecified type.
|
@@ -178,7 +243,6 @@ module Google
|
|
178
243
|
include ::Google::Protobuf::MessageExts
|
179
244
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
245
|
|
181
|
-
# LINT.IfChange
|
182
246
|
# Enum that represents the types of invalid token reasons.
|
183
247
|
module InvalidReason
|
184
248
|
# Default unspecified type.
|
@@ -198,6 +262,41 @@ module Google
|
|
198
262
|
|
199
263
|
# The user verification token was not present.
|
200
264
|
MISSING = 5
|
265
|
+
|
266
|
+
# A retriable error (such as network failure) occurred on the browser.
|
267
|
+
# Could easily be simulated by an attacker.
|
268
|
+
BROWSER_ERROR = 6
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
# Account Defender risk assessment.
|
273
|
+
# @!attribute [rw] labels
|
274
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
|
275
|
+
# Labels for this request.
|
276
|
+
class AccountDefenderAssessment
|
277
|
+
include ::Google::Protobuf::MessageExts
|
278
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
279
|
+
|
280
|
+
# Labels returned by Account Defender for this request.
|
281
|
+
module AccountDefenderLabel
|
282
|
+
# Default unspecified type.
|
283
|
+
ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0
|
284
|
+
|
285
|
+
# The request matches a known good profile for the user.
|
286
|
+
PROFILE_MATCH = 1
|
287
|
+
|
288
|
+
# The request is potentially a suspicious login event and should be further
|
289
|
+
# verified either via multi-factor authentication or another system.
|
290
|
+
SUSPICIOUS_LOGIN_ACTIVITY = 2
|
291
|
+
|
292
|
+
# The request matched a profile that previously had suspicious account
|
293
|
+
# creation behavior. This could mean this is a fake account.
|
294
|
+
SUSPICIOUS_ACCOUNT_CREATION = 3
|
295
|
+
|
296
|
+
# The account in the request has a high number of related accounts. It does
|
297
|
+
# not necessarily imply that the account is bad but could require
|
298
|
+
# investigating.
|
299
|
+
RELATED_ACCOUNTS_NUMBER_HIGH = 4
|
201
300
|
end
|
202
301
|
end
|
203
302
|
|
@@ -261,7 +360,7 @@ module Google
|
|
261
360
|
# Required. The key to update.
|
262
361
|
# @!attribute [rw] update_mask
|
263
362
|
# @return [::Google::Protobuf::FieldMask]
|
264
|
-
# Optional. The mask to control which
|
363
|
+
# Optional. The mask to control which fields of the key get updated. If the mask is not
|
265
364
|
# present, all fields will be updated.
|
266
365
|
class UpdateKeyRequest
|
267
366
|
include ::Google::Protobuf::MessageExts
|
@@ -278,6 +377,48 @@ module Google
|
|
278
377
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
279
378
|
end
|
280
379
|
|
380
|
+
# The migrate key request message.
|
381
|
+
# @!attribute [rw] name
|
382
|
+
# @return [::String]
|
383
|
+
# Required. The name of the key to be migrated, in the format
|
384
|
+
# "projects/\\{project}/keys/\\{key}".
|
385
|
+
class MigrateKeyRequest
|
386
|
+
include ::Google::Protobuf::MessageExts
|
387
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
388
|
+
end
|
389
|
+
|
390
|
+
# The get metrics request message.
|
391
|
+
# @!attribute [rw] name
|
392
|
+
# @return [::String]
|
393
|
+
# Required. The name of the requested metrics, in the format
|
394
|
+
# "projects/\\{project}/keys/\\{key}/metrics".
|
395
|
+
class GetMetricsRequest
|
396
|
+
include ::Google::Protobuf::MessageExts
|
397
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
398
|
+
end
|
399
|
+
|
400
|
+
# Metrics for a single Key.
|
401
|
+
# @!attribute [r] name
|
402
|
+
# @return [::String]
|
403
|
+
# Output only. The name of the metrics, in the format
|
404
|
+
# "projects/\\{project}/keys/\\{key}/metrics".
|
405
|
+
# @!attribute [rw] start_time
|
406
|
+
# @return [::Google::Protobuf::Timestamp]
|
407
|
+
# Inclusive start time aligned to a day (UTC).
|
408
|
+
# @!attribute [rw] score_metrics
|
409
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::ScoreMetrics>]
|
410
|
+
# Metrics will be continuous and in order by dates, and in the granularity
|
411
|
+
# of day. All Key types should have score-based data.
|
412
|
+
# @!attribute [rw] challenge_metrics
|
413
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::ChallengeMetrics>]
|
414
|
+
# Metrics will be continuous and in order by dates, and in the granularity
|
415
|
+
# of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have
|
416
|
+
# challenge-based data.
|
417
|
+
class Metrics
|
418
|
+
include ::Google::Protobuf::MessageExts
|
419
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
420
|
+
end
|
421
|
+
|
281
422
|
# A key used to identify and configure applications (web and/or mobile) that
|
282
423
|
# use reCAPTCHA Enterprise.
|
283
424
|
# @!attribute [rw] name
|
@@ -298,11 +439,14 @@ module Google
|
|
298
439
|
# Settings for keys that can be used by iOS apps.
|
299
440
|
# @!attribute [rw] labels
|
300
441
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
301
|
-
#
|
442
|
+
# See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
|
302
443
|
# Creating and managing labels</a>.
|
303
444
|
# @!attribute [rw] create_time
|
304
445
|
# @return [::Google::Protobuf::Timestamp]
|
305
446
|
# The timestamp corresponding to the creation of this Key.
|
447
|
+
# @!attribute [rw] testing_options
|
448
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions]
|
449
|
+
# Options for user acceptance testing.
|
306
450
|
class Key
|
307
451
|
include ::Google::Protobuf::MessageExts
|
308
452
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -317,6 +461,37 @@ module Google
|
|
317
461
|
end
|
318
462
|
end
|
319
463
|
|
464
|
+
# Options for user acceptance testing.
|
465
|
+
# @!attribute [rw] testing_score
|
466
|
+
# @return [::Float]
|
467
|
+
# All assessments for this Key will return this score. Must be between 0
|
468
|
+
# (likely not legitimate) and 1 (likely legitimate) inclusive.
|
469
|
+
# @!attribute [rw] testing_challenge
|
470
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions::TestingChallenge]
|
471
|
+
# For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
|
472
|
+
# for this site will return nocaptcha if NOCAPTCHA, or an unsolvable
|
473
|
+
# challenge if CHALLENGE.
|
474
|
+
class TestingOptions
|
475
|
+
include ::Google::Protobuf::MessageExts
|
476
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
477
|
+
|
478
|
+
# Enum that represents the challenge option for challenge-based (CHECKBOX,
|
479
|
+
# INVISIBLE) testing keys.
|
480
|
+
module TestingChallenge
|
481
|
+
# Perform the normal risk analysis and return either nocaptcha or a
|
482
|
+
# challenge depending on risk and trust factors.
|
483
|
+
TESTING_CHALLENGE_UNSPECIFIED = 0
|
484
|
+
|
485
|
+
# Challenge requests for this key always return a nocaptcha, which
|
486
|
+
# does not require a solution.
|
487
|
+
NOCAPTCHA = 1
|
488
|
+
|
489
|
+
# Challenge requests for this key always return an unsolvable
|
490
|
+
# challenge.
|
491
|
+
UNSOLVABLE_CHALLENGE = 2
|
492
|
+
end
|
493
|
+
end
|
494
|
+
|
320
495
|
# Settings specific to keys that can be used by websites.
|
321
496
|
# @!attribute [rw] allow_all_domains
|
322
497
|
# @return [::Boolean]
|
@@ -329,7 +504,8 @@ module Google
|
|
329
504
|
# Examples: 'example.com' or 'subdomain.example.com'
|
330
505
|
# @!attribute [rw] allow_amp_traffic
|
331
506
|
# @return [::Boolean]
|
332
|
-
#
|
507
|
+
# If set to true, the key can be used on AMP (Accelerated Mobile Pages)
|
508
|
+
# websites. This is supported only for the SCORE integration type.
|
333
509
|
# @!attribute [rw] integration_type
|
334
510
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType]
|
335
511
|
# Required. Describes how this key is integrated with the website.
|
@@ -380,6 +556,9 @@ module Google
|
|
380
556
|
end
|
381
557
|
|
382
558
|
# Settings specific to keys that can be used by Android apps.
|
559
|
+
# @!attribute [rw] allow_all_package_names
|
560
|
+
# @return [::Boolean]
|
561
|
+
# If set to true, allowed_package_names are not enforced.
|
383
562
|
# @!attribute [rw] allowed_package_names
|
384
563
|
# @return [::Array<::String>]
|
385
564
|
# Android package names of apps allowed to use the key.
|
@@ -390,6 +569,9 @@ module Google
|
|
390
569
|
end
|
391
570
|
|
392
571
|
# Settings specific to keys that can be used by iOS apps.
|
572
|
+
# @!attribute [rw] allow_all_bundle_ids
|
573
|
+
# @return [::Boolean]
|
574
|
+
# If set to true, allowed_bundle_ids are not enforced.
|
393
575
|
# @!attribute [rw] allowed_bundle_ids
|
394
576
|
# @return [::Array<::String>]
|
395
577
|
# iOS bundle ids of apps allowed to use the key.
|
@@ -398,6 +580,213 @@ module Google
|
|
398
580
|
include ::Google::Protobuf::MessageExts
|
399
581
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
400
582
|
end
|
583
|
+
|
584
|
+
# Score distribution.
|
585
|
+
# @!attribute [rw] score_buckets
|
586
|
+
# @return [::Google::Protobuf::Map{::Integer => ::Integer}]
|
587
|
+
# Map key is score value multiplied by 100. The scores are discrete values
|
588
|
+
# between [0, 1]. The maximum number of buckets is on order of a few dozen,
|
589
|
+
# but typically much lower (ie. 10).
|
590
|
+
class ScoreDistribution
|
591
|
+
include ::Google::Protobuf::MessageExts
|
592
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
593
|
+
|
594
|
+
# @!attribute [rw] key
|
595
|
+
# @return [::Integer]
|
596
|
+
# @!attribute [rw] value
|
597
|
+
# @return [::Integer]
|
598
|
+
class ScoreBucketsEntry
|
599
|
+
include ::Google::Protobuf::MessageExts
|
600
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
601
|
+
end
|
602
|
+
end
|
603
|
+
|
604
|
+
# Metrics related to scoring.
|
605
|
+
# @!attribute [rw] overall_metrics
|
606
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution]
|
607
|
+
# Aggregated score metrics for all traffic.
|
608
|
+
# @!attribute [rw] action_metrics
|
609
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution}]
|
610
|
+
# Action-based metrics. The map key is the action name which specified by the
|
611
|
+
# site owners at time of the "execute" client-side call.
|
612
|
+
# Populated only for SCORE keys.
|
613
|
+
class ScoreMetrics
|
614
|
+
include ::Google::Protobuf::MessageExts
|
615
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
616
|
+
|
617
|
+
# @!attribute [rw] key
|
618
|
+
# @return [::String]
|
619
|
+
# @!attribute [rw] value
|
620
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution]
|
621
|
+
class ActionMetricsEntry
|
622
|
+
include ::Google::Protobuf::MessageExts
|
623
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
624
|
+
end
|
625
|
+
end
|
626
|
+
|
627
|
+
# Metrics related to challenges.
|
628
|
+
# @!attribute [rw] pageload_count
|
629
|
+
# @return [::Integer]
|
630
|
+
# Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent
|
631
|
+
# to a count of pageloads for pages that include reCAPTCHA.
|
632
|
+
# @!attribute [rw] nocaptcha_count
|
633
|
+
# @return [::Integer]
|
634
|
+
# Count of nocaptchas (successful verification without a challenge) issued.
|
635
|
+
# @!attribute [rw] failed_count
|
636
|
+
# @return [::Integer]
|
637
|
+
# Count of submitted challenge solutions that were incorrect or otherwise
|
638
|
+
# deemed suspicious such that a subsequent challenge was triggered.
|
639
|
+
# @!attribute [rw] passed_count
|
640
|
+
# @return [::Integer]
|
641
|
+
# Count of nocaptchas (successful verification without a challenge) plus
|
642
|
+
# submitted challenge solutions that were correct and resulted in
|
643
|
+
# verification.
|
644
|
+
class ChallengeMetrics
|
645
|
+
include ::Google::Protobuf::MessageExts
|
646
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
647
|
+
end
|
648
|
+
|
649
|
+
# The request message to list memberships in a related account group.
|
650
|
+
# @!attribute [rw] parent
|
651
|
+
# @return [::String]
|
652
|
+
# Required. The resource name for the related account group in the format
|
653
|
+
# `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
|
654
|
+
# @!attribute [rw] page_size
|
655
|
+
# @return [::Integer]
|
656
|
+
# Optional. The maximum number of accounts to return. The service may return fewer than
|
657
|
+
# this value.
|
658
|
+
# If unspecified, at most 50 accounts will be returned.
|
659
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
660
|
+
# @!attribute [rw] page_token
|
661
|
+
# @return [::String]
|
662
|
+
# Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
|
663
|
+
# call.
|
664
|
+
#
|
665
|
+
# When paginating, all other parameters provided to
|
666
|
+
# `ListRelatedAccountGroupMemberships` must match the call that provided the
|
667
|
+
# page token.
|
668
|
+
class ListRelatedAccountGroupMembershipsRequest
|
669
|
+
include ::Google::Protobuf::MessageExts
|
670
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
671
|
+
end
|
672
|
+
|
673
|
+
# The response to a `ListRelatedAccountGroupMemberships` call.
|
674
|
+
# @!attribute [rw] related_account_group_memberships
|
675
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
|
676
|
+
# The memberships listed by the query.
|
677
|
+
# @!attribute [rw] next_page_token
|
678
|
+
# @return [::String]
|
679
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
680
|
+
# If this field is omitted, there are no subsequent pages.
|
681
|
+
class ListRelatedAccountGroupMembershipsResponse
|
682
|
+
include ::Google::Protobuf::MessageExts
|
683
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
684
|
+
end
|
685
|
+
|
686
|
+
# The request message to list related account groups.
|
687
|
+
# @!attribute [rw] parent
|
688
|
+
# @return [::String]
|
689
|
+
# Required. The name of the project to list related account groups from, in the format
|
690
|
+
# "projects/\\{project}".
|
691
|
+
# @!attribute [rw] page_size
|
692
|
+
# @return [::Integer]
|
693
|
+
# Optional. The maximum number of groups to return. The service may return fewer than
|
694
|
+
# this value.
|
695
|
+
# If unspecified, at most 50 groups will be returned.
|
696
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
697
|
+
# @!attribute [rw] page_token
|
698
|
+
# @return [::String]
|
699
|
+
# Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
|
700
|
+
# Provide this to retrieve the subsequent page.
|
701
|
+
#
|
702
|
+
# When paginating, all other parameters provided to
|
703
|
+
# `ListRelatedAccountGroups` must match the call that provided the page
|
704
|
+
# token.
|
705
|
+
class ListRelatedAccountGroupsRequest
|
706
|
+
include ::Google::Protobuf::MessageExts
|
707
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
708
|
+
end
|
709
|
+
|
710
|
+
# The response to a `ListRelatedAccountGroups` call.
|
711
|
+
# @!attribute [rw] related_account_groups
|
712
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>]
|
713
|
+
# The groups of related accounts listed by the query.
|
714
|
+
# @!attribute [rw] next_page_token
|
715
|
+
# @return [::String]
|
716
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
717
|
+
# If this field is omitted, there are no subsequent pages.
|
718
|
+
class ListRelatedAccountGroupsResponse
|
719
|
+
include ::Google::Protobuf::MessageExts
|
720
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
721
|
+
end
|
722
|
+
|
723
|
+
# The request message to search related account group memberships.
|
724
|
+
# @!attribute [rw] parent
|
725
|
+
# @return [::String]
|
726
|
+
# Required. The name of the project to search related account group memberships from,
|
727
|
+
# in the format "projects/\\{project}".
|
728
|
+
# @!attribute [rw] hashed_account_id
|
729
|
+
# @return [::String]
|
730
|
+
# Optional. The unique stable hashed user identifier we should search connections to.
|
731
|
+
# The identifier should correspond to a `hashed_account_id` provided in a
|
732
|
+
# previous CreateAssessment or AnnotateAssessment call.
|
733
|
+
# @!attribute [rw] page_size
|
734
|
+
# @return [::Integer]
|
735
|
+
# Optional. The maximum number of groups to return. The service may return fewer than
|
736
|
+
# this value.
|
737
|
+
# If unspecified, at most 50 groups will be returned.
|
738
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
739
|
+
# @!attribute [rw] page_token
|
740
|
+
# @return [::String]
|
741
|
+
# Optional. A page token, received from a previous
|
742
|
+
# `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
|
743
|
+
# subsequent page.
|
744
|
+
#
|
745
|
+
# When paginating, all other parameters provided to
|
746
|
+
# `SearchRelatedAccountGroupMemberships` must match the call that provided
|
747
|
+
# the page token.
|
748
|
+
class SearchRelatedAccountGroupMembershipsRequest
|
749
|
+
include ::Google::Protobuf::MessageExts
|
750
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
751
|
+
end
|
752
|
+
|
753
|
+
# The response to a `SearchRelatedAccountGroupMemberships` call.
|
754
|
+
# @!attribute [rw] related_account_group_memberships
|
755
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
|
756
|
+
# The queried memberships.
|
757
|
+
# @!attribute [rw] next_page_token
|
758
|
+
# @return [::String]
|
759
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
760
|
+
# If this field is omitted, there are no subsequent pages.
|
761
|
+
class SearchRelatedAccountGroupMembershipsResponse
|
762
|
+
include ::Google::Protobuf::MessageExts
|
763
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
764
|
+
end
|
765
|
+
|
766
|
+
# A membership in a group of related accounts.
|
767
|
+
# @!attribute [rw] name
|
768
|
+
# @return [::String]
|
769
|
+
# Required. The resource name for this membership in the format
|
770
|
+
# `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`.
|
771
|
+
# @!attribute [rw] hashed_account_id
|
772
|
+
# @return [::String]
|
773
|
+
# The unique stable hashed user identifier of the member. The identifier
|
774
|
+
# corresponds to a `hashed_account_id` provided in a previous
|
775
|
+
# CreateAssessment or AnnotateAssessment call.
|
776
|
+
class RelatedAccountGroupMembership
|
777
|
+
include ::Google::Protobuf::MessageExts
|
778
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
779
|
+
end
|
780
|
+
|
781
|
+
# A group of related accounts.
|
782
|
+
# @!attribute [rw] name
|
783
|
+
# @return [::String]
|
784
|
+
# Required. The resource name for the related account group in the format
|
785
|
+
# `projects/{project}/relatedaccountgroups/{related_account_group}`.
|
786
|
+
class RelatedAccountGroup
|
787
|
+
include ::Google::Protobuf::MessageExts
|
788
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
789
|
+
end
|
401
790
|
end
|
402
791
|
end
|
403
792
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-recaptcha_enterprise-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
204
204
|
- !ruby/object:Gem::Version
|
205
205
|
version: '0'
|
206
206
|
requirements: []
|
207
|
-
rubygems_version: 3.
|
207
|
+
rubygems_version: 3.3.4
|
208
208
|
signing_key:
|
209
209
|
specification_version: 4
|
210
210
|
summary: API Client library for the reCAPTCHA Enterprise V1 API
|