organization_settings.proto 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. // Copyright 2020 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.securitycenter.v1beta1;
  16. import "google/api/resource.proto";
  17. import "google/api/annotations.proto";
  18. option go_package = "google.golang.org/genproto/googleapis/cloud/securitycenter/v1beta1;securitycenter";
  19. option java_multiple_files = true;
  20. option java_package = "com.google.cloud.securitycenter.v1beta1";
  21. // User specified settings that are attached to the Security Command
  22. // Center organization.
  23. message OrganizationSettings {
  24. option (google.api.resource) = {
  25. type: "securitycenter.googleapis.com/OrganizationSettings"
  26. pattern: "organizations/{organization}/organizationSettings"
  27. };
  28. // The configuration used for Asset Discovery runs.
  29. message AssetDiscoveryConfig {
  30. // The mode of inclusion when running Asset Discovery.
  31. // Asset discovery can be limited by explicitly identifying projects to be
  32. // included or excluded. If INCLUDE_ONLY is set, then only those projects
  33. // within the organization and their children are discovered during asset
  34. // discovery. If EXCLUDE is set, then projects that don't match those
  35. // projects are discovered during asset discovery. If neither are set, then
  36. // all projects within the organization are discovered during asset
  37. // discovery.
  38. enum InclusionMode {
  39. // Unspecified. Setting the mode with this value will disable
  40. // inclusion/exclusion filtering for Asset Discovery.
  41. INCLUSION_MODE_UNSPECIFIED = 0;
  42. // Asset Discovery will capture only the resources within the projects
  43. // specified. All other resources will be ignored.
  44. INCLUDE_ONLY = 1;
  45. // Asset Discovery will ignore all resources under the projects specified.
  46. // All other resources will be retrieved.
  47. EXCLUDE = 2;
  48. }
  49. // The project ids to use for filtering asset discovery.
  50. repeated string project_ids = 1;
  51. // The mode to use for filtering asset discovery.
  52. InclusionMode inclusion_mode = 2;
  53. }
  54. // The relative resource name of the settings. See:
  55. // https://cloud.google.com/apis/design/resource_names#relative_resource_name
  56. // Example:
  57. // "organizations/{organization_id}/organizationSettings".
  58. string name = 1;
  59. // A flag that indicates if Asset Discovery should be enabled. If the flag is
  60. // set to `true`, then discovery of assets will occur. If it is set to `false,
  61. // all historical assets will remain, but discovery of future assets will not
  62. // occur.
  63. bool enable_asset_discovery = 2;
  64. // The configuration used for Asset Discovery runs.
  65. AssetDiscoveryConfig asset_discovery_config = 3;
  66. }