-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
security_settings.proto
380 lines (333 loc) · 14.4 KB
/
security_settings.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
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
368
369
370
371
372
373
374
375
376
377
378
379
380
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.dialogflow.cx.v3;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
option go_package = "cloud.google.com/go/dialogflow/cx/apiv3/cxpb;cxpb";
option java_multiple_files = true;
option java_outer_classname = "SecuritySettingsProto";
option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
option (google.api.resource_definition) = {
type: "dlp.googleapis.com/InspectTemplate"
pattern: "organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}"
pattern: "projects/{project}/locations/{location}/inspectTemplates/{inspect_template}"
};
option (google.api.resource_definition) = {
type: "dlp.googleapis.com/DeidentifyTemplate"
pattern: "organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}"
pattern: "projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}"
};
// Service for managing security settings for Dialogflow.
service SecuritySettingsService {
option (google.api.default_host) = "dialogflow.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/dialogflow";
// Create security settings in the specified location.
rpc CreateSecuritySettings(CreateSecuritySettingsRequest)
returns (SecuritySettings) {
option (google.api.http) = {
post: "/v3/{parent=projects/*/locations/*}/securitySettings"
body: "security_settings"
};
option (google.api.method_signature) = "parent,security_settings";
}
// Retrieves the specified
// [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]. The
// returned settings may be stale by up to 1 minute.
rpc GetSecuritySettings(GetSecuritySettingsRequest)
returns (SecuritySettings) {
option (google.api.http) = {
get: "/v3/{name=projects/*/locations/*/securitySettings/*}"
};
option (google.api.method_signature) = "name";
}
// Updates the specified
// [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
rpc UpdateSecuritySettings(UpdateSecuritySettingsRequest)
returns (SecuritySettings) {
option (google.api.http) = {
patch: "/v3/{security_settings.name=projects/*/locations/*/securitySettings/*}"
body: "security_settings"
};
option (google.api.method_signature) = "security_settings,update_mask";
}
// Returns the list of all security settings in the specified location.
rpc ListSecuritySettings(ListSecuritySettingsRequest)
returns (ListSecuritySettingsResponse) {
option (google.api.http) = {
get: "/v3/{parent=projects/*/locations/*}/securitySettings"
};
option (google.api.method_signature) = "parent";
}
// Deletes the specified
// [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
rpc DeleteSecuritySettings(DeleteSecuritySettingsRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v3/{name=projects/*/locations/*/securitySettings/*}"
};
option (google.api.method_signature) = "name";
}
}
// The request message for
// [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].
message GetSecuritySettingsRequest {
// Required. Resource name of the settings.
// Format: `projects/<Project ID>/locations/<Location
// ID>/securitySettings/<security settings ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/SecuritySettings"
}
];
}
// The request message for
// [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].
message UpdateSecuritySettingsRequest {
// Required. [SecuritySettings] object that contains values for each of the
// fields to update.
SecuritySettings security_settings = 1
[(google.api.field_behavior) = REQUIRED];
// Required. The mask to control which fields get updated. If the mask is not
// present, all fields will be updated.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// The request message for [SecuritySettings.ListSecuritySettings][].
message ListSecuritySettingsRequest {
// Required. The location to list all security settings for.
// Format: `projects/<Project ID>/locations/<Location ID>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/SecuritySettings"
}
];
// The maximum number of items to return in a single page. By default 20 and
// at most 100.
int32 page_size = 2;
// The next_page_token value returned from a previous list request.
string page_token = 3;
}
// The response message for [SecuritySettings.ListSecuritySettings][].
message ListSecuritySettingsResponse {
// The list of security settings.
repeated SecuritySettings security_settings = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
}
// The request message for [SecuritySettings.CreateSecuritySettings][].
message CreateSecuritySettingsRequest {
// Required. The location to create an
// [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for.
// Format: `projects/<Project ID>/locations/<Location ID>`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/SecuritySettings"
}
];
// Required. The security settings to create.
SecuritySettings security_settings = 2
[(google.api.field_behavior) = REQUIRED];
}
// The request message for [SecuritySettings.DeleteSecuritySettings][].
message DeleteSecuritySettingsRequest {
// Required. The name of the
// [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to
// delete. Format: `projects/<Project ID>/locations/<Location
// ID>/securitySettings/<Security Settings ID>`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/SecuritySettings"
}
];
}
// Represents the settings related to security issues, such as data redaction
// and data retention. It may take hours for updates on the settings to
// propagate to all the related components and take effect.
message SecuritySettings {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/SecuritySettings"
pattern: "projects/{project}/locations/{location}/securitySettings/{security_settings}"
};
// Defines how we redact data.
enum RedactionStrategy {
// Do not redact.
REDACTION_STRATEGY_UNSPECIFIED = 0;
// Call redaction service to clean up the data to be persisted.
REDACT_WITH_SERVICE = 1;
}
// Defines what types of data to redact.
enum RedactionScope {
// Don't redact any kind of data.
REDACTION_SCOPE_UNSPECIFIED = 0;
// On data to be written to disk or similar devices that are capable of
// holding data even if power is disconnected. This includes data that are
// temporarily saved on disk.
REDACT_DISK_STORAGE = 2;
}
// Type of data we purge after retention settings triggers purge.
enum PurgeDataType {
// Unspecified. Do not use.
PURGE_DATA_TYPE_UNSPECIFIED = 0;
// Dialogflow history. This does not include Cloud logging, which is
// owned by the user - not Dialogflow.
DIALOGFLOW_HISTORY = 1;
}
// Settings for exporting audio.
message AudioExportSettings {
// File format for exported audio file. Currently only in telephony
// recordings.
enum AudioFormat {
// Unspecified. Do not use.
AUDIO_FORMAT_UNSPECIFIED = 0;
// G.711 mu-law PCM with 8kHz sample rate.
MULAW = 1;
// MP3 file format.
MP3 = 2;
// OGG Vorbis.
OGG = 3;
}
// Cloud Storage bucket to export audio record to.
// Setting this field would grant the Storage Object Creator role to
// the Dialogflow Service Agent.
// API caller that tries to modify this field should have the permission of
// storage.buckets.setIamPolicy.
string gcs_bucket = 1;
// Filename pattern for exported audio.
string audio_export_pattern = 2;
// Enable audio redaction if it is true.
bool enable_audio_redaction = 3;
// File format for exported audio file. Currently only in telephony
// recordings.
AudioFormat audio_format = 4;
}
// Settings for exporting conversations to
// [Insights](https://cloud.google.com/contact-center/insights/docs).
message InsightsExportSettings {
// If enabled, we will automatically exports
// conversations to Insights and Insights runs its analyzers.
bool enable_insights_export = 1;
}
// Resource name of the settings.
// Required for the
// [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings]
// method.
// [SecuritySettingsService.CreateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.CreateSecuritySettings]
// populates the name automatically. Format: `projects/<Project
// ID>/locations/<Location ID>/securitySettings/<Security Settings ID>`.
string name = 1;
// Required. The human-readable name of the security settings, unique within
// the location.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Strategy that defines how we do redaction.
RedactionStrategy redaction_strategy = 3;
// Defines the data for which Dialogflow applies redaction. Dialogflow does
// not redact data that it does not have access to – for example, Cloud
// logging.
RedactionScope redaction_scope = 4;
// [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
// template to define inspect base settings.
//
// The `DLP Inspect Templates Reader` role is needed on the Dialogflow
// service identity service account (has the form
// `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`)
// for your agent's project.
//
// If empty, we use the default DLP inspect config.
//
// The template name will have one of the following formats:
// `projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template
// ID>` OR `organizations/<Organization ID>/locations/<Location
// ID>/inspectTemplates/<Template ID>`
//
// Note: `inspect_template` must be located in the same region as the
// `SecuritySettings`.
string inspect_template = 9 [(google.api.resource_reference) = {
type: "dlp.googleapis.com/InspectTemplate"
}];
// [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
// template to define de-identification configuration for the content.
//
// The `DLP De-identify Templates Reader` role is needed on the Dialogflow
// service identity service account (has the form
// `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`)
// for your agent's project.
//
// If empty, Dialogflow replaces sensitive info with `[redacted]` text.
//
// The template name will have one of the following formats:
// `projects/<Project ID>/locations/<Location
// ID>/deidentifyTemplates/<Template ID>` OR `organizations/<Organization
// ID>/locations/<Location ID>/deidentifyTemplates/<Template ID>`
//
// Note: `deidentify_template` must be located in the same region as the
// `SecuritySettings`.
string deidentify_template = 17 [(google.api.resource_reference) = {
type: "dlp.googleapis.com/DeidentifyTemplate"
}];
// Specifies how data is retained. Note that even if the data is
// purged due to retention policy, we may still hold it in backup storage for
// a few days without allowing direct readings.
oneof data_retention {
// Retains the data for the specified number of days.
// User must set a value lower than Dialogflow's default 365d TTL (30 days
// for Agent Assist traffic), higher value will be ignored and use default.
// Setting a value higher than that has no effect. A missing value or
// setting to 0 also means we use default TTL.
int32 retention_window_days = 6;
}
// List of types of data to remove when retention settings triggers purge.
repeated PurgeDataType purge_data_types = 8;
// Controls audio export settings for post-conversation analytics when
// ingesting audio to conversations via [Participants.AnalyzeContent][] or
// [Participants.StreamingAnalyzeContent][].
//
// If
// [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
// is set to REMOVE_AFTER_CONVERSATION or [audio_export_settings.gcs_bucket][]
// is empty, audio export is disabled.
//
// If audio export is enabled, audio is recorded and saved to
// [audio_export_settings.gcs_bucket][], subject to retention policy of
// [audio_export_settings.gcs_bucket][].
//
// This setting won't effect audio input for implicit sessions via
// [Sessions.DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent]
// or
// [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent].
AudioExportSettings audio_export_settings = 12;
// Controls conversation exporting settings to Insights after conversation is
// completed.
//
// If
// [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy]
// is set to REMOVE_AFTER_CONVERSATION, Insights export is disabled no matter
// what you configure here.
InsightsExportSettings insights_export_settings = 13;
}