@@ -36,7 +36,8 @@ option ruby_package = "Google::Cloud::RecaptchaEnterprise::V1";
36
36
// Service to determine the likelihood an event is legitimate.
37
37
service RecaptchaEnterpriseService {
38
38
option (google.api.default_host ) = "recaptchaenterprise.googleapis.com" ;
39
- option (google.api.oauth_scopes ) = "https://www.googleapis.com/auth/cloud-platform" ;
39
+ option (google.api.oauth_scopes ) =
40
+ "https://www.googleapis.com/auth/cloud-platform" ;
40
41
41
42
// Creates an Assessment of the likelihood an event is legitimate.
42
43
rpc CreateAssessment (CreateAssessmentRequest ) returns (Assessment ) {
@@ -49,7 +50,8 @@ service RecaptchaEnterpriseService {
49
50
50
51
// Annotates a previously created Assessment to provide additional information
51
52
// on whether the event turned out to be authentic or fraudulent.
52
- rpc AnnotateAssessment (AnnotateAssessmentRequest ) returns (AnnotateAssessmentResponse ) {
53
+ rpc AnnotateAssessment (AnnotateAssessmentRequest )
54
+ returns (AnnotateAssessmentResponse ) {
53
55
option (google.api.http ) = {
54
56
post : "/v1/{name=projects/*/assessments/*}:annotate"
55
57
body : "*"
@@ -117,23 +119,28 @@ service RecaptchaEnterpriseService {
117
119
}
118
120
119
121
// List groups of related accounts.
120
- rpc ListRelatedAccountGroups (ListRelatedAccountGroupsRequest ) returns (ListRelatedAccountGroupsResponse ) {
122
+ rpc ListRelatedAccountGroups (ListRelatedAccountGroupsRequest )
123
+ returns (ListRelatedAccountGroupsResponse ) {
121
124
option (google.api.http ) = {
122
125
get : "/v1/{parent=projects/*}/relatedaccountgroups"
123
126
};
124
127
option (google.api.method_signature ) = "parent" ;
125
128
}
126
129
127
130
// Get the memberships in a group of related accounts.
128
- rpc ListRelatedAccountGroupMemberships (ListRelatedAccountGroupMembershipsRequest ) returns (ListRelatedAccountGroupMembershipsResponse ) {
131
+ rpc ListRelatedAccountGroupMemberships (
132
+ ListRelatedAccountGroupMembershipsRequest )
133
+ returns (ListRelatedAccountGroupMembershipsResponse ) {
129
134
option (google.api.http ) = {
130
135
get : "/v1/{parent=projects/*/relatedaccountgroups/*}/memberships"
131
136
};
132
137
option (google.api.method_signature ) = "parent" ;
133
138
}
134
139
135
140
// Search group memberships related to a given account.
136
- rpc SearchRelatedAccountGroupMemberships (SearchRelatedAccountGroupMembershipsRequest ) returns (SearchRelatedAccountGroupMembershipsResponse ) {
141
+ rpc SearchRelatedAccountGroupMemberships (
142
+ SearchRelatedAccountGroupMembershipsRequest )
143
+ returns (SearchRelatedAccountGroupMembershipsResponse ) {
137
144
option (google.api.http ) = {
138
145
post : "/v1/{project=projects/*}/relatedaccountgroupmemberships:search"
139
146
body : "*"
@@ -234,26 +241,25 @@ message AnnotateAssessmentRequest {
234
241
}
235
242
];
236
243
237
- // Optional. The annotation that will be assigned to the Event. This field can be left
238
- // empty to provide reasons that apply to an event without concluding whether
239
- // the event is legitimate or fraudulent.
244
+ // Optional. The annotation that will be assigned to the Event. This field can
245
+ // be left empty to provide reasons that apply to an event without concluding
246
+ // whether the event is legitimate or fraudulent.
240
247
Annotation annotation = 2 [(google.api.field_behavior ) = OPTIONAL ];
241
248
242
- // Optional. Optional reasons for the annotation that will be assigned to the Event.
249
+ // Optional. Optional reasons for the annotation that will be assigned to the
250
+ // Event.
243
251
repeated Reason reasons = 3 [(google.api.field_behavior ) = OPTIONAL ];
244
252
245
- // Optional. Optional unique stable hashed user identifier to apply to the assessment.
246
- // This is an alternative to setting the hashed_account_id in
253
+ // Optional. Optional unique stable hashed user identifier to apply to the
254
+ // assessment. This is an alternative to setting the hashed_account_id in
247
255
// CreateAssessment, for example when the account identifier is not yet known
248
256
// in the initial request. It is recommended that the identifier is hashed
249
257
// using hmac-sha256 with stable secret.
250
258
bytes hashed_account_id = 4 [(google.api.field_behavior ) = OPTIONAL ];
251
259
}
252
260
253
261
// Empty response for AnnotateAssessment.
254
- message AnnotateAssessmentResponse {
255
-
256
- }
262
+ message AnnotateAssessmentResponse {}
257
263
258
264
// A recaptcha assessment resource.
259
265
message Assessment {
@@ -273,36 +279,41 @@ message Assessment {
273
279
RiskAnalysis risk_analysis = 3 [(google.api.field_behavior ) = OUTPUT_ONLY ];
274
280
275
281
// Output only. Properties of the provided event token.
276
- TokenProperties token_properties = 4 [(google.api.field_behavior ) = OUTPUT_ONLY ];
282
+ TokenProperties token_properties = 4
283
+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
277
284
278
285
// Assessment returned by Account Defender when a hashed_account_id is
279
286
// provided.
280
287
AccountDefenderAssessment account_defender_assessment = 6 ;
288
+
289
+ // Password leak verification info.
290
+ PrivatePasswordLeakVerification private_password_leak_verification = 7 ;
281
291
}
282
292
283
293
message Event {
284
- // Optional. The user response token provided by the reCAPTCHA client-side integration
285
- // on your site.
294
+ // Optional. The user response token provided by the reCAPTCHA client-side
295
+ // integration on your site.
286
296
string token = 1 [(google.api.field_behavior ) = OPTIONAL ];
287
297
288
- // Optional. The site key that was used to invoke reCAPTCHA on your site and generate
289
- // the token.
298
+ // Optional. The site key that was used to invoke reCAPTCHA on your site and
299
+ // generate the token.
290
300
string site_key = 2 [(google.api.field_behavior ) = OPTIONAL ];
291
301
292
- // Optional. The user agent present in the request from the user's device related to
293
- // this event.
302
+ // Optional. The user agent present in the request from the user's device
303
+ // related to this event.
294
304
string user_agent = 3 [(google.api.field_behavior ) = OPTIONAL ];
295
305
296
- // Optional. The IP address in the request from the user's device related to this event.
306
+ // Optional. The IP address in the request from the user's device related to
307
+ // this event.
297
308
string user_ip_address = 4 [(google.api.field_behavior ) = OPTIONAL ];
298
309
299
- // Optional. The expected action for this type of event. This should be the same action
300
- // provided at token generation time on client-side platforms already
301
- // integrated with recaptcha enterprise.
310
+ // Optional. The expected action for this type of event. This should be the
311
+ // same action provided at token generation time on client-side platforms
312
+ // already integrated with recaptcha enterprise.
302
313
string expected_action = 5 [(google.api.field_behavior ) = OPTIONAL ];
303
314
304
- // Optional. Optional unique stable hashed user identifier for the request. The
305
- // identifier should ideally be hashed using sha256 with stable secret.
315
+ // Optional. Optional unique stable hashed user identifier for the request.
316
+ // The identifier should ideally be hashed using sha256 with stable secret.
306
317
bytes hashed_account_id = 6 [(google.api.field_behavior ) = OPTIONAL ];
307
318
}
308
319
@@ -414,6 +425,31 @@ message AccountDefenderAssessment {
414
425
repeated AccountDefenderLabel labels = 1 ;
415
426
}
416
427
428
+ // Private password leak verification info.
429
+ message PrivatePasswordLeakVerification {
430
+ // Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It
431
+ // is used to look up password leaks associated with that hash prefix.
432
+ bytes lookup_hash_prefix = 1 [(google.api.field_behavior ) = OPTIONAL ];
433
+
434
+ // Encrypted Scrypt hash of the canonicalized username+password. It is
435
+ // re-encrypted by the server and returned through
436
+ // `reencrypted_user_credentials_hash`.
437
+ bytes encrypted_user_credentials_hash = 2
438
+ [(google.api.field_behavior ) = OPTIONAL ];
439
+
440
+ // List of prefixes of the encrypted potential password leaks that matched the
441
+ // given parameters. They should be compared with the client-side decryption
442
+ // prefix of `reencrypted_user_credentials_hash`
443
+ repeated bytes encrypted_leak_match_prefixes = 3
444
+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
445
+
446
+ // Corresponds to the re-encryption of the `encrypted_user_credentials_hash`
447
+ // field. Used to match potential password leaks within
448
+ // `encrypted_leak_match_prefixes`.
449
+ bytes reencrypted_user_credentials_hash = 4
450
+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
451
+ }
452
+
417
453
// The create key request message.
418
454
message CreateKeyRequest {
419
455
// Required. The name of the project in which the key will be created, in the
@@ -476,9 +512,10 @@ message UpdateKeyRequest {
476
512
// Required. The key to update.
477
513
Key key = 1 [(google.api.field_behavior ) = REQUIRED ];
478
514
479
- // Optional. The mask to control which fields of the key get updated. If the mask is not
480
- // present, all fields will be updated.
481
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior ) = OPTIONAL ];
515
+ // Optional. The mask to control which fields of the key get updated. If the
516
+ // mask is not present, all fields will be updated.
517
+ google.protobuf.FieldMask update_mask = 2
518
+ [(google.api.field_behavior ) = OPTIONAL ];
482
519
}
483
520
484
521
// The delete key request message.
@@ -740,14 +777,14 @@ message ListRelatedAccountGroupMembershipsRequest {
740
777
}
741
778
];
742
779
743
- // Optional. The maximum number of accounts to return. The service may return fewer than
744
- // this value.
745
- // If unspecified, at most 50 accounts will be returned.
746
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
780
+ // Optional. The maximum number of accounts to return. The service may return
781
+ // fewer than this value. If unspecified, at most 50 accounts will be
782
+ // returned. The maximum value is 1000; values above 1000 will be coerced to
783
+ // 1000.
747
784
int32 page_size = 2 [(google.api.field_behavior ) = OPTIONAL ];
748
785
749
- // Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
750
- // call.
786
+ // Optional. A page token, received from a previous
787
+ // `ListRelatedAccountGroupMemberships` call.
751
788
//
752
789
// When paginating, all other parameters provided to
753
790
// `ListRelatedAccountGroupMemberships` must match the call that provided the
@@ -767,23 +804,22 @@ message ListRelatedAccountGroupMembershipsResponse {
767
804
768
805
// The request message to list related account groups.
769
806
message ListRelatedAccountGroupsRequest {
770
- // Required. The name of the project to list related account groups from, in the format
771
- // "projects/{project}".
807
+ // Required. The name of the project to list related account groups from, in
808
+ // the format "projects/{project}".
772
809
string parent = 1 [
773
810
(google.api.field_behavior ) = REQUIRED ,
774
811
(google.api.resource_reference ) = {
775
812
child_type : "recaptchaenterprise.googleapis.com/RelatedAccountGroup"
776
813
}
777
814
];
778
815
779
- // Optional. The maximum number of groups to return. The service may return fewer than
780
- // this value.
781
- // If unspecified, at most 50 groups will be returned.
816
+ // Optional. The maximum number of groups to return. The service may return
817
+ // fewer than this value. If unspecified, at most 50 groups will be returned.
782
818
// The maximum value is 1000; values above 1000 will be coerced to 1000.
783
819
int32 page_size = 2 [(google.api.field_behavior ) = OPTIONAL ];
784
820
785
- // Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
786
- // Provide this to retrieve the subsequent page.
821
+ // Optional. A page token, received from a previous `ListRelatedAccountGroups`
822
+ // call. Provide this to retrieve the subsequent page.
787
823
//
788
824
// When paginating, all other parameters provided to
789
825
// `ListRelatedAccountGroups` must match the call that provided the page
@@ -803,23 +839,22 @@ message ListRelatedAccountGroupsResponse {
803
839
804
840
// The request message to search related account group memberships.
805
841
message SearchRelatedAccountGroupMembershipsRequest {
806
- // Required. The name of the project to search related account group memberships from,
807
- // in the format "projects/{project}".
842
+ // Required. The name of the project to search related account group
843
+ // memberships from, in the format "projects/{project}".
808
844
string project = 1 [
809
845
(google.api.field_behavior ) = REQUIRED ,
810
846
(google.api.resource_reference ) = {
811
847
child_type : "recaptchaenterprise.googleapis.com/RelatedAccountGroupMembership"
812
848
}
813
849
];
814
850
815
- // Optional. The unique stable hashed user identifier we should search connections to.
816
- // The identifier should correspond to a `hashed_account_id` provided in a
817
- // previous CreateAssessment or AnnotateAssessment call.
851
+ // Optional. The unique stable hashed user identifier we should search
852
+ // connections to. The identifier should correspond to a `hashed_account_id`
853
+ // provided in a previous CreateAssessment or AnnotateAssessment call.
818
854
bytes hashed_account_id = 2 [(google.api.field_behavior ) = OPTIONAL ];
819
855
820
- // Optional. The maximum number of groups to return. The service may return fewer than
821
- // this value.
822
- // If unspecified, at most 50 groups will be returned.
856
+ // Optional. The maximum number of groups to return. The service may return
857
+ // fewer than this value. If unspecified, at most 50 groups will be returned.
823
858
// The maximum value is 1000; values above 1000 will be coerced to 1000.
824
859
int32 page_size = 3 [(google.api.field_behavior ) = OPTIONAL ];
825
860
0 commit comments