1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://policysimulator.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Policy Simulator",
15 "description": " Policy Simulator is a collection of endpoints for creating, running, and viewing a Replay. A `Replay` is a type of simulation that lets you see how your members' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members' access might change under the proposed policy.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/iam/docs/simulating-access",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "policysimulator:v1beta1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://policysimulator.mtls.googleapis.com/",
26 "name": "policysimulator",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "folders": {
109 "resources": {
110 "locations": {
111 "resources": {
112 "orgPolicyViolationsPreviews": {
113 "resources": {
114 "operations": {
115 "methods": {
116 "get": {
117 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
118 "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}",
119 "httpMethod": "GET",
120 "id": "policysimulator.folders.locations.orgPolicyViolationsPreviews.operations.get",
121 "parameterOrder": [
122 "name"
123 ],
124 "parameters": {
125 "name": {
126 "description": "The name of the operation resource.",
127 "location": "path",
128 "pattern": "^folders/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$",
129 "required": true,
130 "type": "string"
131 }
132 },
133 "path": "v1beta1/{+name}",
134 "response": {
135 "$ref": "GoogleLongrunningOperation"
136 },
137 "scopes": [
138 "https://www.googleapis.com/auth/cloud-platform"
139 ]
140 }
141 }
142 }
143 }
144 },
145 "replays": {
146 "resources": {
147 "operations": {
148 "methods": {
149 "get": {
150 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
151 "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}",
152 "httpMethod": "GET",
153 "id": "policysimulator.folders.locations.replays.operations.get",
154 "parameterOrder": [
155 "name"
156 ],
157 "parameters": {
158 "name": {
159 "description": "The name of the operation resource.",
160 "location": "path",
161 "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+/operations/.*$",
162 "required": true,
163 "type": "string"
164 }
165 },
166 "path": "v1beta1/{+name}",
167 "response": {
168 "$ref": "GoogleLongrunningOperation"
169 },
170 "scopes": [
171 "https://www.googleapis.com/auth/cloud-platform"
172 ]
173 },
174 "list": {
175 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
176 "flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/replays/{replaysId}/operations",
177 "httpMethod": "GET",
178 "id": "policysimulator.folders.locations.replays.operations.list",
179 "parameterOrder": [
180 "name"
181 ],
182 "parameters": {
183 "filter": {
184 "description": "The standard list filter.",
185 "location": "query",
186 "type": "string"
187 },
188 "name": {
189 "description": "The name of the operation's parent resource.",
190 "location": "path",
191 "pattern": "^folders/[^/]+/locations/[^/]+/replays/[^/]+/operations$",
192 "required": true,
193 "type": "string"
194 },
195 "pageSize": {
196 "description": "The standard list page size.",
197 "format": "int32",
198 "location": "query",
199 "type": "integer"
200 },
201 "pageToken": {
202 "description": "The standard list page token.",
203 "location": "query",
204 "type": "string"
205 }
206 },
207 "path": "v1beta1/{+name}",
208 "response": {
209 "$ref": "GoogleLongrunningListOperationsResponse"
210 },
211 "scopes": [
212 "https://www.googleapis.com/auth/cloud-platform"
213 ]
214 }
215 }
216 }
217 }
218 }
219 }
220 }
221 }
222 },
223 "operations": {
224 "methods": {
225 "get": {
226 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
227 "flatPath": "v1beta1/operations/{operationsId}",
228 "httpMethod": "GET",
229 "id": "policysimulator.operations.get",
230 "parameterOrder": [
231 "name"
232 ],
233 "parameters": {
234 "name": {
235 "description": "The name of the operation resource.",
236 "location": "path",
237 "pattern": "^operations/.*$",
238 "required": true,
239 "type": "string"
240 }
241 },
242 "path": "v1beta1/{+name}",
243 "response": {
244 "$ref": "GoogleLongrunningOperation"
245 },
246 "scopes": [
247 "https://www.googleapis.com/auth/cloud-platform"
248 ]
249 },
250 "list": {
251 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
252 "flatPath": "v1beta1/operations",
253 "httpMethod": "GET",
254 "id": "policysimulator.operations.list",
255 "parameterOrder": [
256 "name"
257 ],
258 "parameters": {
259 "filter": {
260 "description": "The standard list filter.",
261 "location": "query",
262 "type": "string"
263 },
264 "name": {
265 "description": "The name of the operation's parent resource.",
266 "location": "path",
267 "pattern": "^operations$",
268 "required": true,
269 "type": "string"
270 },
271 "pageSize": {
272 "description": "The standard list page size.",
273 "format": "int32",
274 "location": "query",
275 "type": "integer"
276 },
277 "pageToken": {
278 "description": "The standard list page token.",
279 "location": "query",
280 "type": "string"
281 }
282 },
283 "path": "v1beta1/{+name}",
284 "response": {
285 "$ref": "GoogleLongrunningListOperationsResponse"
286 },
287 "scopes": [
288 "https://www.googleapis.com/auth/cloud-platform"
289 ]
290 }
291 }
292 },
293 "organizations": {
294 "resources": {
295 "locations": {
296 "resources": {
297 "orgPolicyViolationsPreviews": {
298 "resources": {
299 "operations": {
300 "methods": {
301 "get": {
302 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
303 "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}",
304 "httpMethod": "GET",
305 "id": "policysimulator.organizations.locations.orgPolicyViolationsPreviews.operations.get",
306 "parameterOrder": [
307 "name"
308 ],
309 "parameters": {
310 "name": {
311 "description": "The name of the operation resource.",
312 "location": "path",
313 "pattern": "^organizations/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$",
314 "required": true,
315 "type": "string"
316 }
317 },
318 "path": "v1beta1/{+name}",
319 "response": {
320 "$ref": "GoogleLongrunningOperation"
321 },
322 "scopes": [
323 "https://www.googleapis.com/auth/cloud-platform"
324 ]
325 }
326 }
327 }
328 }
329 },
330 "replays": {
331 "resources": {
332 "operations": {
333 "methods": {
334 "get": {
335 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
336 "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}",
337 "httpMethod": "GET",
338 "id": "policysimulator.organizations.locations.replays.operations.get",
339 "parameterOrder": [
340 "name"
341 ],
342 "parameters": {
343 "name": {
344 "description": "The name of the operation resource.",
345 "location": "path",
346 "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+/operations/.*$",
347 "required": true,
348 "type": "string"
349 }
350 },
351 "path": "v1beta1/{+name}",
352 "response": {
353 "$ref": "GoogleLongrunningOperation"
354 },
355 "scopes": [
356 "https://www.googleapis.com/auth/cloud-platform"
357 ]
358 },
359 "list": {
360 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
361 "flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/replays/{replaysId}/operations",
362 "httpMethod": "GET",
363 "id": "policysimulator.organizations.locations.replays.operations.list",
364 "parameterOrder": [
365 "name"
366 ],
367 "parameters": {
368 "filter": {
369 "description": "The standard list filter.",
370 "location": "query",
371 "type": "string"
372 },
373 "name": {
374 "description": "The name of the operation's parent resource.",
375 "location": "path",
376 "pattern": "^organizations/[^/]+/locations/[^/]+/replays/[^/]+/operations$",
377 "required": true,
378 "type": "string"
379 },
380 "pageSize": {
381 "description": "The standard list page size.",
382 "format": "int32",
383 "location": "query",
384 "type": "integer"
385 },
386 "pageToken": {
387 "description": "The standard list page token.",
388 "location": "query",
389 "type": "string"
390 }
391 },
392 "path": "v1beta1/{+name}",
393 "response": {
394 "$ref": "GoogleLongrunningListOperationsResponse"
395 },
396 "scopes": [
397 "https://www.googleapis.com/auth/cloud-platform"
398 ]
399 }
400 }
401 }
402 }
403 }
404 }
405 }
406 }
407 },
408 "projects": {
409 "resources": {
410 "locations": {
411 "resources": {
412 "orgPolicyViolationsPreviews": {
413 "resources": {
414 "operations": {
415 "methods": {
416 "get": {
417 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
418 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/orgPolicyViolationsPreviews/{orgPolicyViolationsPreviewsId}/operations/{operationsId}",
419 "httpMethod": "GET",
420 "id": "policysimulator.projects.locations.orgPolicyViolationsPreviews.operations.get",
421 "parameterOrder": [
422 "name"
423 ],
424 "parameters": {
425 "name": {
426 "description": "The name of the operation resource.",
427 "location": "path",
428 "pattern": "^projects/[^/]+/locations/[^/]+/orgPolicyViolationsPreviews/[^/]+/operations/.*$",
429 "required": true,
430 "type": "string"
431 }
432 },
433 "path": "v1beta1/{+name}",
434 "response": {
435 "$ref": "GoogleLongrunningOperation"
436 },
437 "scopes": [
438 "https://www.googleapis.com/auth/cloud-platform"
439 ]
440 }
441 }
442 }
443 }
444 },
445 "replays": {
446 "resources": {
447 "operations": {
448 "methods": {
449 "get": {
450 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
451 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations/{operationsId}",
452 "httpMethod": "GET",
453 "id": "policysimulator.projects.locations.replays.operations.get",
454 "parameterOrder": [
455 "name"
456 ],
457 "parameters": {
458 "name": {
459 "description": "The name of the operation resource.",
460 "location": "path",
461 "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+/operations/.*$",
462 "required": true,
463 "type": "string"
464 }
465 },
466 "path": "v1beta1/{+name}",
467 "response": {
468 "$ref": "GoogleLongrunningOperation"
469 },
470 "scopes": [
471 "https://www.googleapis.com/auth/cloud-platform"
472 ]
473 },
474 "list": {
475 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
476 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replays/{replaysId}/operations",
477 "httpMethod": "GET",
478 "id": "policysimulator.projects.locations.replays.operations.list",
479 "parameterOrder": [
480 "name"
481 ],
482 "parameters": {
483 "filter": {
484 "description": "The standard list filter.",
485 "location": "query",
486 "type": "string"
487 },
488 "name": {
489 "description": "The name of the operation's parent resource.",
490 "location": "path",
491 "pattern": "^projects/[^/]+/locations/[^/]+/replays/[^/]+/operations$",
492 "required": true,
493 "type": "string"
494 },
495 "pageSize": {
496 "description": "The standard list page size.",
497 "format": "int32",
498 "location": "query",
499 "type": "integer"
500 },
501 "pageToken": {
502 "description": "The standard list page token.",
503 "location": "query",
504 "type": "string"
505 }
506 },
507 "path": "v1beta1/{+name}",
508 "response": {
509 "$ref": "GoogleLongrunningListOperationsResponse"
510 },
511 "scopes": [
512 "https://www.googleapis.com/auth/cloud-platform"
513 ]
514 }
515 }
516 }
517 }
518 }
519 }
520 }
521 }
522 }
523 },
524 "revision": "20230219",
525 "rootUrl": "https://policysimulator.googleapis.com/",
526 "schemas": {
527 "GoogleCloudPolicysimulatorV1Replay": {
528 "description": "A resource describing a `Replay`, or simulation.",
529 "id": "GoogleCloudPolicysimulatorV1Replay",
530 "properties": {
531 "config": {
532 "$ref": "GoogleCloudPolicysimulatorV1ReplayConfig",
533 "description": "Required. The configuration used for the `Replay`."
534 },
535 "name": {
536 "description": "Output only. The resource name of the `Replay`, which has the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`",
537 "readOnly": true,
538 "type": "string"
539 },
540 "resultsSummary": {
541 "$ref": "GoogleCloudPolicysimulatorV1ReplayResultsSummary",
542 "description": "Output only. Summary statistics about the replayed log entries.",
543 "readOnly": true
544 },
545 "state": {
546 "description": "Output only. The current state of the `Replay`.",
547 "enum": [
548 "STATE_UNSPECIFIED",
549 "PENDING",
550 "RUNNING",
551 "SUCCEEDED",
552 "FAILED"
553 ],
554 "enumDescriptions": [
555 "Default value. This value is unused.",
556 "The `Replay` has not started yet.",
557 "The `Replay` is currently running.",
558 "The `Replay` has successfully completed.",
559 "The `Replay` has finished with an error."
560 ],
561 "readOnly": true,
562 "type": "string"
563 }
564 },
565 "type": "object"
566 },
567 "GoogleCloudPolicysimulatorV1ReplayConfig": {
568 "description": "The configuration used for a Replay.",
569 "id": "GoogleCloudPolicysimulatorV1ReplayConfig",
570 "properties": {
571 "logSource": {
572 "description": "The logs to use as input for the Replay.",
573 "enum": [
574 "LOG_SOURCE_UNSPECIFIED",
575 "RECENT_ACCESSES"
576 ],
577 "enumDescriptions": [
578 "An unspecified log source. If the log source is unspecified, the Replay defaults to using `RECENT_ACCESSES`.",
579 "All access logs from the last 90 days. These logs may not include logs from the most recent 7 days."
580 ],
581 "type": "string"
582 },
583 "policyOverlay": {
584 "additionalProperties": {
585 "$ref": "GoogleIamV1Policy"
586 },
587 "description": "A mapping of the resources that you want to simulate policies for and the policies that you want to simulate. Keys are the full resource names for the resources. For example, `//cloudresourcemanager.googleapis.com/projects/my-project`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. Values are Policy objects representing the policies that you want to simulate. Replays automatically take into account any IAM policies inherited through the resource hierarchy, and any policies set on descendant resources. You do not need to include these policies in the policy overlay.",
588 "type": "object"
589 }
590 },
591 "type": "object"
592 },
593 "GoogleCloudPolicysimulatorV1ReplayOperationMetadata": {
594 "description": "Metadata about a Replay operation.",
595 "id": "GoogleCloudPolicysimulatorV1ReplayOperationMetadata",
596 "properties": {
597 "startTime": {
598 "description": "Time when the request was received.",
599 "format": "google-datetime",
600 "type": "string"
601 }
602 },
603 "type": "object"
604 },
605 "GoogleCloudPolicysimulatorV1ReplayResultsSummary": {
606 "description": "Summary statistics about the replayed log entries.",
607 "id": "GoogleCloudPolicysimulatorV1ReplayResultsSummary",
608 "properties": {
609 "differenceCount": {
610 "description": "The number of replayed log entries with a difference between baseline and simulated policies.",
611 "format": "int32",
612 "type": "integer"
613 },
614 "errorCount": {
615 "description": "The number of log entries that could not be replayed.",
616 "format": "int32",
617 "type": "integer"
618 },
619 "logCount": {
620 "description": "The total number of log entries replayed.",
621 "format": "int32",
622 "type": "integer"
623 },
624 "newestDate": {
625 "$ref": "GoogleTypeDate",
626 "description": "The date of the newest log entry replayed."
627 },
628 "oldestDate": {
629 "$ref": "GoogleTypeDate",
630 "description": "The date of the oldest log entry replayed."
631 },
632 "unchangedCount": {
633 "description": "The number of replayed log entries with no difference between baseline and simulated policies.",
634 "format": "int32",
635 "type": "integer"
636 }
637 },
638 "type": "object"
639 },
640 "GoogleCloudPolicysimulatorV1beta1Replay": {
641 "description": "A resource describing a `Replay`, or simulation.",
642 "id": "GoogleCloudPolicysimulatorV1beta1Replay",
643 "properties": {
644 "config": {
645 "$ref": "GoogleCloudPolicysimulatorV1beta1ReplayConfig",
646 "description": "Required. The configuration used for the `Replay`."
647 },
648 "name": {
649 "description": "Output only. The resource name of the `Replay`, which has the following format: `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`",
650 "readOnly": true,
651 "type": "string"
652 },
653 "resultsSummary": {
654 "$ref": "GoogleCloudPolicysimulatorV1beta1ReplayResultsSummary",
655 "description": "Output only. Summary statistics about the replayed log entries.",
656 "readOnly": true
657 },
658 "state": {
659 "description": "Output only. The current state of the `Replay`.",
660 "enum": [
661 "STATE_UNSPECIFIED",
662 "PENDING",
663 "RUNNING",
664 "SUCCEEDED",
665 "FAILED"
666 ],
667 "enumDescriptions": [
668 "The state is unspecified.",
669 "The `Replay` has not started yet.",
670 "The `Replay` is currently running.",
671 "The `Replay` has successfully completed.",
672 "The `Replay` has finished with an error."
673 ],
674 "readOnly": true,
675 "type": "string"
676 }
677 },
678 "type": "object"
679 },
680 "GoogleCloudPolicysimulatorV1beta1ReplayConfig": {
681 "description": "The configuration used for a Replay.",
682 "id": "GoogleCloudPolicysimulatorV1beta1ReplayConfig",
683 "properties": {
684 "logSource": {
685 "description": "The logs to use as input for the Replay.",
686 "enum": [
687 "LOG_SOURCE_UNSPECIFIED",
688 "RECENT_ACCESSES"
689 ],
690 "enumDescriptions": [
691 "An unspecified log source. If the log source is unspecified, the Replay defaults to using `RECENT_ACCESSES`.",
692 "All access logs from the last 90 days. These logs may not include logs from the most recent 7 days."
693 ],
694 "type": "string"
695 },
696 "policyOverlay": {
697 "additionalProperties": {
698 "$ref": "GoogleIamV1Policy"
699 },
700 "description": "A mapping of the resources that you want to simulate policies for and the policies that you want to simulate. Keys are the full resource names for the resources. For example, `//cloudresourcemanager.googleapis.com/projects/my-project`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names. Values are Policy objects representing the policies that you want to simulate. Replays automatically take into account any IAM policies inherited through the resource hierarchy, and any policies set on descendant resources. You do not need to include these policies in the policy overlay.",
701 "type": "object"
702 }
703 },
704 "type": "object"
705 },
706 "GoogleCloudPolicysimulatorV1beta1ReplayOperationMetadata": {
707 "description": "Metadata about a Replay operation.",
708 "id": "GoogleCloudPolicysimulatorV1beta1ReplayOperationMetadata",
709 "properties": {
710 "startTime": {
711 "description": "Time when the request was received.",
712 "format": "google-datetime",
713 "type": "string"
714 }
715 },
716 "type": "object"
717 },
718 "GoogleCloudPolicysimulatorV1beta1ReplayResultsSummary": {
719 "description": "Summary statistics about the replayed log entries.",
720 "id": "GoogleCloudPolicysimulatorV1beta1ReplayResultsSummary",
721 "properties": {
722 "differenceCount": {
723 "description": "The number of replayed log entries with a difference between baseline and simulated policies.",
724 "format": "int32",
725 "type": "integer"
726 },
727 "errorCount": {
728 "description": "The number of log entries that could not be replayed.",
729 "format": "int32",
730 "type": "integer"
731 },
732 "logCount": {
733 "description": "The total number of log entries replayed.",
734 "format": "int32",
735 "type": "integer"
736 },
737 "newestDate": {
738 "$ref": "GoogleTypeDate",
739 "description": "The date of the newest log entry replayed."
740 },
741 "oldestDate": {
742 "$ref": "GoogleTypeDate",
743 "description": "The date of the oldest log entry replayed."
744 },
745 "unchangedCount": {
746 "description": "The number of replayed log entries with no difference between baseline and simulated policies.",
747 "format": "int32",
748 "type": "integer"
749 }
750 },
751 "type": "object"
752 },
753 "GoogleIamV1AuditConfig": {
754 "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
755 "id": "GoogleIamV1AuditConfig",
756 "properties": {
757 "auditLogConfigs": {
758 "description": "The configuration for logging of each type of permission.",
759 "items": {
760 "$ref": "GoogleIamV1AuditLogConfig"
761 },
762 "type": "array"
763 },
764 "service": {
765 "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
766 "type": "string"
767 }
768 },
769 "type": "object"
770 },
771 "GoogleIamV1AuditLogConfig": {
772 "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
773 "id": "GoogleIamV1AuditLogConfig",
774 "properties": {
775 "exemptedMembers": {
776 "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
777 "items": {
778 "type": "string"
779 },
780 "type": "array"
781 },
782 "logType": {
783 "description": "The log type that this config enables.",
784 "enum": [
785 "LOG_TYPE_UNSPECIFIED",
786 "ADMIN_READ",
787 "DATA_WRITE",
788 "DATA_READ"
789 ],
790 "enumDescriptions": [
791 "Default case. Should never be this.",
792 "Admin reads. Example: CloudIAM getIamPolicy",
793 "Data writes. Example: CloudSQL Users create",
794 "Data reads. Example: CloudSQL Users list"
795 ],
796 "type": "string"
797 }
798 },
799 "type": "object"
800 },
801 "GoogleIamV1Binding": {
802 "description": "Associates `members`, or principals, with a `role`.",
803 "id": "GoogleIamV1Binding",
804 "properties": {
805 "condition": {
806 "$ref": "GoogleTypeExpr",
807 "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
808 },
809 "members": {
810 "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.",
811 "items": {
812 "type": "string"
813 },
814 "type": "array"
815 },
816 "role": {
817 "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
818 "type": "string"
819 }
820 },
821 "type": "object"
822 },
823 "GoogleIamV1Policy": {
824 "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
825 "id": "GoogleIamV1Policy",
826 "properties": {
827 "auditConfigs": {
828 "description": "Specifies cloud audit logging configuration for this policy.",
829 "items": {
830 "$ref": "GoogleIamV1AuditConfig"
831 },
832 "type": "array"
833 },
834 "bindings": {
835 "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
836 "items": {
837 "$ref": "GoogleIamV1Binding"
838 },
839 "type": "array"
840 },
841 "etag": {
842 "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
843 "format": "byte",
844 "type": "string"
845 },
846 "version": {
847 "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
848 "format": "int32",
849 "type": "integer"
850 }
851 },
852 "type": "object"
853 },
854 "GoogleLongrunningListOperationsResponse": {
855 "description": "The response message for Operations.ListOperations.",
856 "id": "GoogleLongrunningListOperationsResponse",
857 "properties": {
858 "nextPageToken": {
859 "description": "The standard List next-page token.",
860 "type": "string"
861 },
862 "operations": {
863 "description": "A list of operations that matches the specified filter in the request.",
864 "items": {
865 "$ref": "GoogleLongrunningOperation"
866 },
867 "type": "array"
868 }
869 },
870 "type": "object"
871 },
872 "GoogleLongrunningOperation": {
873 "description": "This resource represents a long-running operation that is the result of a network API call.",
874 "id": "GoogleLongrunningOperation",
875 "properties": {
876 "done": {
877 "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
878 "type": "boolean"
879 },
880 "error": {
881 "$ref": "GoogleRpcStatus",
882 "description": "The error result of the operation in case of failure or cancellation."
883 },
884 "metadata": {
885 "additionalProperties": {
886 "description": "Properties of the object. Contains field @type with type URL.",
887 "type": "any"
888 },
889 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
890 "type": "object"
891 },
892 "name": {
893 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
894 "type": "string"
895 },
896 "response": {
897 "additionalProperties": {
898 "description": "Properties of the object. Contains field @type with type URL.",
899 "type": "any"
900 },
901 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
902 "type": "object"
903 }
904 },
905 "type": "object"
906 },
907 "GoogleRpcStatus": {
908 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
909 "id": "GoogleRpcStatus",
910 "properties": {
911 "code": {
912 "description": "The status code, which should be an enum value of google.rpc.Code.",
913 "format": "int32",
914 "type": "integer"
915 },
916 "details": {
917 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
918 "items": {
919 "additionalProperties": {
920 "description": "Properties of the object. Contains field @type with type URL.",
921 "type": "any"
922 },
923 "type": "object"
924 },
925 "type": "array"
926 },
927 "message": {
928 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
929 "type": "string"
930 }
931 },
932 "type": "object"
933 },
934 "GoogleTypeDate": {
935 "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
936 "id": "GoogleTypeDate",
937 "properties": {
938 "day": {
939 "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
940 "format": "int32",
941 "type": "integer"
942 },
943 "month": {
944 "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
945 "format": "int32",
946 "type": "integer"
947 },
948 "year": {
949 "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
950 "format": "int32",
951 "type": "integer"
952 }
953 },
954 "type": "object"
955 },
956 "GoogleTypeExpr": {
957 "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
958 "id": "GoogleTypeExpr",
959 "properties": {
960 "description": {
961 "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
962 "type": "string"
963 },
964 "expression": {
965 "description": "Textual representation of an expression in Common Expression Language syntax.",
966 "type": "string"
967 },
968 "location": {
969 "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
970 "type": "string"
971 },
972 "title": {
973 "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
974 "type": "string"
975 }
976 },
977 "type": "object"
978 }
979 },
980 "servicePath": "",
981 "title": "Policy Simulator API",
982 "version": "v1beta1",
983 "version_module": true
984}View as plain text