12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880 |
- // Copyright 2022 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.securitycenter.v1;
- import public "google/cloud/securitycenter/v1/run_asset_discovery_response.proto";
- import "google/api/annotations.proto";
- import "google/api/client.proto";
- import "google/api/field_behavior.proto";
- import "google/api/resource.proto";
- import "google/cloud/securitycenter/v1/asset.proto";
- import "google/cloud/securitycenter/v1/bigquery_export.proto";
- import "google/cloud/securitycenter/v1/external_system.proto";
- import "google/cloud/securitycenter/v1/finding.proto";
- import "google/cloud/securitycenter/v1/folder.proto";
- import "google/cloud/securitycenter/v1/mute_config.proto";
- import "google/cloud/securitycenter/v1/notification_config.proto";
- import "google/cloud/securitycenter/v1/organization_settings.proto";
- import "google/cloud/securitycenter/v1/security_marks.proto";
- import "google/cloud/securitycenter/v1/source.proto";
- import "google/iam/v1/iam_policy.proto";
- import "google/iam/v1/policy.proto";
- import "google/longrunning/operations.proto";
- import "google/protobuf/duration.proto";
- import "google/protobuf/empty.proto";
- import "google/protobuf/field_mask.proto";
- import "google/protobuf/struct.proto";
- import "google/protobuf/timestamp.proto";
- option csharp_namespace = "Google.Cloud.SecurityCenter.V1";
- option go_package = "google.golang.org/genproto/googleapis/cloud/securitycenter/v1;securitycenter";
- option java_multiple_files = true;
- option java_package = "com.google.cloud.securitycenter.v1";
- option php_namespace = "Google\\Cloud\\SecurityCenter\\V1";
- option ruby_package = "Google::Cloud::SecurityCenter::V1";
- // V1 APIs for Security Center service.
- service SecurityCenter {
- option (google.api.default_host) = "securitycenter.googleapis.com";
- option (google.api.oauth_scopes) =
- "https://www.googleapis.com/auth/cloud-platform";
- // Kicks off an LRO to bulk mute findings for a parent based on a filter. The
- // parent can be either an organization, folder or project. The findings
- // matched by the filter will be muted after the LRO is done.
- rpc BulkMuteFindings(BulkMuteFindingsRequest)
- returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/findings:bulkMute"
- body: "*"
- additional_bindings {
- post: "/v1/{parent=folders/*}/findings:bulkMute"
- body: "*"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*}/findings:bulkMute"
- body: "*"
- }
- };
- option (google.api.method_signature) = "parent";
- option (google.longrunning.operation_info) = {
- response_type: "google.cloud.securitycenter.v1.BulkMuteFindingsResponse"
- metadata_type: "google.protobuf.Empty"
- };
- }
- // Creates a source.
- rpc CreateSource(CreateSourceRequest) returns (Source) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/sources"
- body: "source"
- };
- option (google.api.method_signature) = "parent,source";
- }
- // Creates a finding. The corresponding source must exist for finding creation
- // to succeed.
- rpc CreateFinding(CreateFindingRequest) returns (Finding) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*/sources/*}/findings"
- body: "finding"
- };
- option (google.api.method_signature) = "parent,finding_id,finding";
- }
- // Creates a mute config.
- rpc CreateMuteConfig(CreateMuteConfigRequest) returns (MuteConfig) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/muteConfigs"
- body: "mute_config"
- additional_bindings {
- post: "/v1/{parent=folders/*}/muteConfigs"
- body: "mute_config"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*}/muteConfigs"
- body: "mute_config"
- }
- };
- option (google.api.method_signature) = "parent,mute_config";
- option (google.api.method_signature) = "parent,mute_config,mute_config_id";
- }
- // Creates a notification config.
- rpc CreateNotificationConfig(CreateNotificationConfigRequest)
- returns (NotificationConfig) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/notificationConfigs"
- body: "notification_config"
- additional_bindings {
- post: "/v1/{parent=folders/*}/notificationConfigs"
- body: "notification_config"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*}/notificationConfigs"
- body: "notification_config"
- }
- };
- option (google.api.method_signature) =
- "parent,config_id,notification_config";
- option (google.api.method_signature) = "parent,notification_config";
- }
- // Deletes an existing mute config.
- rpc DeleteMuteConfig(DeleteMuteConfigRequest)
- returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v1/{name=organizations/*/muteConfigs/*}"
- additional_bindings { delete: "/v1/{name=folders/*/muteConfigs/*}" }
- additional_bindings { delete: "/v1/{name=projects/*/muteConfigs/*}" }
- };
- option (google.api.method_signature) = "name";
- }
- // Deletes a notification config.
- rpc DeleteNotificationConfig(DeleteNotificationConfigRequest)
- returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v1/{name=organizations/*/notificationConfigs/*}"
- additional_bindings {
- delete: "/v1/{name=folders/*/notificationConfigs/*}"
- }
- additional_bindings {
- delete: "/v1/{name=projects/*/notificationConfigs/*}"
- }
- };
- option (google.api.method_signature) = "name";
- }
- // Gets a big query export.
- rpc GetBigQueryExport(GetBigQueryExportRequest) returns (BigQueryExport) {
- option (google.api.http) = {
- get: "/v1/{name=organizations/*/bigQueryExports/*}"
- additional_bindings { get: "/v1/{name=folders/*/bigQueryExports/*}" }
- additional_bindings { get: "/v1/{name=projects/*/bigQueryExports/*}" }
- };
- option (google.api.method_signature) = "name";
- }
- // Gets the access control policy on the specified Source.
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
- returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v1/{resource=organizations/*/sources/*}:getIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource";
- }
- // Gets a mute config.
- rpc GetMuteConfig(GetMuteConfigRequest) returns (MuteConfig) {
- option (google.api.http) = {
- get: "/v1/{name=organizations/*/muteConfigs/*}"
- additional_bindings { get: "/v1/{name=folders/*/muteConfigs/*}" }
- additional_bindings { get: "/v1/{name=projects/*/muteConfigs/*}" }
- };
- option (google.api.method_signature) = "name";
- }
- // Gets a notification config.
- rpc GetNotificationConfig(GetNotificationConfigRequest)
- returns (NotificationConfig) {
- option (google.api.http) = {
- get: "/v1/{name=organizations/*/notificationConfigs/*}"
- additional_bindings { get: "/v1/{name=folders/*/notificationConfigs/*}" }
- additional_bindings { get: "/v1/{name=projects/*/notificationConfigs/*}" }
- };
- option (google.api.method_signature) = "name";
- }
- // Gets the settings for an organization.
- rpc GetOrganizationSettings(GetOrganizationSettingsRequest)
- returns (OrganizationSettings) {
- option (google.api.http) = {
- get: "/v1/{name=organizations/*/organizationSettings}"
- };
- option (google.api.method_signature) = "name";
- }
- // Gets a source.
- rpc GetSource(GetSourceRequest) returns (Source) {
- option (google.api.http) = {
- get: "/v1/{name=organizations/*/sources/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Filters an organization's assets and groups them by their specified
- // properties.
- rpc GroupAssets(GroupAssetsRequest) returns (GroupAssetsResponse) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/assets:group"
- body: "*"
- additional_bindings {
- post: "/v1/{parent=folders/*}/assets:group"
- body: "*"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*}/assets:group"
- body: "*"
- }
- };
- }
- // Filters an organization or source's findings and groups them by their
- // specified properties.
- //
- // To group across all sources provide a `-` as the source id.
- // Example: /v1/organizations/{organization_id}/sources/-/findings,
- // /v1/folders/{folder_id}/sources/-/findings,
- // /v1/projects/{project_id}/sources/-/findings
- rpc GroupFindings(GroupFindingsRequest) returns (GroupFindingsResponse) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*/sources/*}/findings:group"
- body: "*"
- additional_bindings {
- post: "/v1/{parent=folders/*/sources/*}/findings:group"
- body: "*"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*/sources/*}/findings:group"
- body: "*"
- }
- };
- option (google.api.method_signature) = "parent,group_by";
- }
- // Lists an organization's assets.
- rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*}/assets"
- additional_bindings { get: "/v1/{parent=folders/*}/assets" }
- additional_bindings { get: "/v1/{parent=projects/*}/assets" }
- };
- }
- // Lists an organization or source's findings.
- //
- // To list across all sources provide a `-` as the source id.
- // Example: /v1/organizations/{organization_id}/sources/-/findings
- rpc ListFindings(ListFindingsRequest) returns (ListFindingsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*/sources/*}/findings"
- additional_bindings { get: "/v1/{parent=folders/*/sources/*}/findings" }
- additional_bindings { get: "/v1/{parent=projects/*/sources/*}/findings" }
- };
- }
- // Lists mute configs.
- rpc ListMuteConfigs(ListMuteConfigsRequest)
- returns (ListMuteConfigsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*}/muteConfigs"
- additional_bindings { get: "/v1/{parent=folders/*}/muteConfigs" }
- additional_bindings { get: "/v1/{parent=projects/*}/muteConfigs" }
- };
- option (google.api.method_signature) = "parent";
- }
- // Lists notification configs.
- rpc ListNotificationConfigs(ListNotificationConfigsRequest)
- returns (ListNotificationConfigsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*}/notificationConfigs"
- additional_bindings { get: "/v1/{parent=folders/*}/notificationConfigs" }
- additional_bindings { get: "/v1/{parent=projects/*}/notificationConfigs" }
- };
- option (google.api.method_signature) = "parent";
- }
- // Lists all sources belonging to an organization.
- rpc ListSources(ListSourcesRequest) returns (ListSourcesResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*}/sources"
- additional_bindings { get: "/v1/{parent=folders/*}/sources" }
- additional_bindings { get: "/v1/{parent=projects/*}/sources" }
- };
- option (google.api.method_signature) = "parent";
- }
- // Runs asset discovery. The discovery is tracked with a long-running
- // operation.
- //
- // This API can only be called with limited frequency for an organization. If
- // it is called too frequently the caller will receive a TOO_MANY_REQUESTS
- // error.
- rpc RunAssetDiscovery(RunAssetDiscoveryRequest)
- returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/assets:runDiscovery"
- body: "*"
- };
- option (google.api.method_signature) = "parent";
- option (google.longrunning.operation_info) = {
- response_type: "google.cloud.securitycenter.v1.RunAssetDiscoveryResponse"
- metadata_type: "google.protobuf.Empty"
- };
- }
- // Updates the state of a finding.
- rpc SetFindingState(SetFindingStateRequest) returns (Finding) {
- option (google.api.http) = {
- post: "/v1/{name=organizations/*/sources/*/findings/*}:setState"
- body: "*"
- additional_bindings {
- post: "/v1/{name=folders/*/sources/*/findings/*}:setState"
- body: "*"
- }
- additional_bindings {
- post: "/v1/{name=projects/*/sources/*/findings/*}:setState"
- body: "*"
- }
- };
- option (google.api.method_signature) = "name,state,start_time";
- }
- // Updates the mute state of a finding.
- rpc SetMute(SetMuteRequest) returns (Finding) {
- option (google.api.http) = {
- post: "/v1/{name=organizations/*/sources/*/findings/*}:setMute"
- body: "*"
- additional_bindings {
- post: "/v1/{name=folders/*/sources/*/findings/*}:setMute"
- body: "*"
- }
- additional_bindings {
- post: "/v1/{name=projects/*/sources/*/findings/*}:setMute"
- body: "*"
- }
- };
- option (google.api.method_signature) = "name,mute";
- }
- // Sets the access control policy on the specified Source.
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
- returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v1/{resource=organizations/*/sources/*}:setIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource,policy";
- }
- // Returns the permissions that a caller has on the specified source.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
- returns (google.iam.v1.TestIamPermissionsResponse) {
- option (google.api.http) = {
- post: "/v1/{resource=organizations/*/sources/*}:testIamPermissions"
- body: "*"
- };
- option (google.api.method_signature) = "resource,permissions";
- }
- // Updates external system. This is for a given finding.
- rpc UpdateExternalSystem(UpdateExternalSystemRequest)
- returns (ExternalSystem) {
- option (google.api.http) = {
- patch: "/v1/{external_system.name=organizations/*/sources/*/findings/*/externalSystems/*}"
- body: "external_system"
- additional_bindings {
- patch: "/v1/{external_system.name=folders/*/sources/*/findings/*/externalSystems/*}"
- body: "external_system"
- }
- additional_bindings {
- patch: "/v1/{external_system.name=projects/*/sources/*/findings/*/externalSystems/*}"
- body: "external_system"
- }
- };
- option (google.api.method_signature) = "external_system,update_mask";
- }
- // Creates or updates a finding. The corresponding source must exist for a
- // finding creation to succeed.
- rpc UpdateFinding(UpdateFindingRequest) returns (Finding) {
- option (google.api.http) = {
- patch: "/v1/{finding.name=organizations/*/sources/*/findings/*}"
- body: "finding"
- additional_bindings {
- patch: "/v1/{finding.name=folders/*/sources/*/findings/*}"
- body: "finding"
- }
- additional_bindings {
- patch: "/v1/{finding.name=projects/*/sources/*/findings/*}"
- body: "finding"
- }
- };
- option (google.api.method_signature) = "finding";
- }
- // Updates a mute config.
- rpc UpdateMuteConfig(UpdateMuteConfigRequest) returns (MuteConfig) {
- option (google.api.http) = {
- patch: "/v1/{mute_config.name=organizations/*/muteConfigs/*}"
- body: "mute_config"
- additional_bindings {
- patch: "/v1/{mute_config.name=folders/*/muteConfigs/*}"
- body: "mute_config"
- }
- additional_bindings {
- patch: "/v1/{mute_config.name=projects/*/muteConfigs/*}"
- body: "mute_config"
- }
- };
- option (google.api.method_signature) = "mute_config,update_mask";
- }
- //
- // Updates a notification config. The following update
- // fields are allowed: description, pubsub_topic, streaming_config.filter
- rpc UpdateNotificationConfig(UpdateNotificationConfigRequest)
- returns (NotificationConfig) {
- option (google.api.http) = {
- patch: "/v1/{notification_config.name=organizations/*/notificationConfigs/*}"
- body: "notification_config"
- additional_bindings {
- patch: "/v1/{notification_config.name=folders/*/notificationConfigs/*}"
- body: "notification_config"
- }
- additional_bindings {
- patch: "/v1/{notification_config.name=projects/*/notificationConfigs/*}"
- body: "notification_config"
- }
- };
- option (google.api.method_signature) = "notification_config";
- option (google.api.method_signature) = "notification_config,update_mask";
- }
- // Updates an organization's settings.
- rpc UpdateOrganizationSettings(UpdateOrganizationSettingsRequest)
- returns (OrganizationSettings) {
- option (google.api.http) = {
- patch: "/v1/{organization_settings.name=organizations/*/organizationSettings}"
- body: "organization_settings"
- };
- option (google.api.method_signature) = "organization_settings";
- }
- // Updates a source.
- rpc UpdateSource(UpdateSourceRequest) returns (Source) {
- option (google.api.http) = {
- patch: "/v1/{source.name=organizations/*/sources/*}"
- body: "source"
- };
- option (google.api.method_signature) = "source";
- }
- // Updates security marks.
- rpc UpdateSecurityMarks(UpdateSecurityMarksRequest) returns (SecurityMarks) {
- option (google.api.http) = {
- patch: "/v1/{security_marks.name=organizations/*/assets/*/securityMarks}"
- body: "security_marks"
- additional_bindings {
- patch: "/v1/{security_marks.name=folders/*/assets/*/securityMarks}"
- body: "security_marks"
- }
- additional_bindings {
- patch: "/v1/{security_marks.name=projects/*/assets/*/securityMarks}"
- body: "security_marks"
- }
- additional_bindings {
- patch: "/v1/{security_marks.name=organizations/*/sources/*/findings/*/securityMarks}"
- body: "security_marks"
- }
- additional_bindings {
- patch: "/v1/{security_marks.name=folders/*/sources/*/findings/*/securityMarks}"
- body: "security_marks"
- }
- additional_bindings {
- patch: "/v1/{security_marks.name=projects/*/sources/*/findings/*/securityMarks}"
- body: "security_marks"
- }
- };
- option (google.api.method_signature) = "security_marks";
- }
- // Creates a big query export.
- rpc CreateBigQueryExport(CreateBigQueryExportRequest)
- returns (BigQueryExport) {
- option (google.api.http) = {
- post: "/v1/{parent=organizations/*}/bigQueryExports"
- body: "big_query_export"
- additional_bindings {
- post: "/v1/{parent=folders/*}/bigQueryExports"
- body: "big_query_export"
- }
- additional_bindings {
- post: "/v1/{parent=projects/*}/bigQueryExports"
- body: "big_query_export"
- }
- };
- option (google.api.method_signature) =
- "parent,big_query_export,big_query_export_id";
- }
- // Deletes an existing big query export.
- rpc DeleteBigQueryExport(DeleteBigQueryExportRequest)
- returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v1/{name=organizations/*/bigQueryExports/*}"
- additional_bindings { delete: "/v1/{name=folders/*/bigQueryExports/*}" }
- additional_bindings { delete: "/v1/{name=projects/*/bigQueryExports/*}" }
- };
- option (google.api.method_signature) = "name";
- }
- // Updates a BigQuery export.
- rpc UpdateBigQueryExport(UpdateBigQueryExportRequest)
- returns (BigQueryExport) {
- option (google.api.http) = {
- patch: "/v1/{big_query_export.name=organizations/*/bigQueryExports/*}"
- body: "big_query_export"
- additional_bindings {
- patch: "/v1/{big_query_export.name=folders/*/bigQueryExports/*}"
- body: "big_query_export"
- }
- additional_bindings {
- patch: "/v1/{big_query_export.name=projects/*/bigQueryExports/*}"
- body: "big_query_export"
- }
- };
- option (google.api.method_signature) = "big_query_export,update_mask";
- }
- // Lists BigQuery exports. Note that when requesting BigQuery exports at a
- // given level all exports under that level are also returned e.g. if
- // requesting BigQuery exports under a folder, then all BigQuery exports
- // immediately under the folder plus the ones created under the projects
- // within the folder are returned.
- rpc ListBigQueryExports(ListBigQueryExportsRequest)
- returns (ListBigQueryExportsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=organizations/*}/bigQueryExports"
- additional_bindings { get: "/v1/{parent=folders/*}/bigQueryExports" }
- additional_bindings { get: "/v1/{parent=projects/*}/bigQueryExports" }
- };
- option (google.api.method_signature) = "parent";
- }
- }
- // Request message for bulk findings update.
- //
- // Note:
- // 1. If multiple bulk update requests match the same resource, the order in
- // which they get executed is not defined.
- // 2. Once a bulk operation is started, there is no way to stop it.
- message BulkMuteFindingsRequest {
- // Required. The parent, at which bulk action needs to be applied. Its format
- // is "organizations/[organization_id]", "folders/[folder_id]",
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = { type: "*" }
- ];
- // Expression that identifies findings that should be updated.
- // The expression is a list of zero or more restrictions combined
- // via logical operators `AND` and `OR`. Parentheses are supported, and `OR`
- // has higher precedence than `AND`.
- //
- // Restrictions have the form `<field> <operator> <value>` and may have a
- // `-` character in front of them to indicate negation. The fields map to
- // those defined in the corresponding resource.
- //
- // The supported operators are:
- //
- // * `=` for all value types.
- // * `>`, `<`, `>=`, `<=` for integer values.
- // * `:`, meaning substring matching, for strings.
- //
- // The supported value types are:
- //
- // * string literals in quotes.
- // * integer literals without quotes.
- // * boolean literals `true` and `false` without quotes.
- string filter = 2;
- // This can be a mute configuration name or any identifier for mute/unmute
- // of findings based on the filter.
- string mute_annotation = 3 [deprecated = true];
- }
- // The response to a BulkMute request. Contains the LRO information.
- message BulkMuteFindingsResponse {}
- // Request message for creating a finding.
- message CreateFindingRequest {
- // Required. Resource name of the new finding's parent. Its format should be
- // "organizations/[organization_id]/sources/[source_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Source"
- }
- ];
- // Required. Unique identifier provided by the client within the parent scope.
- // It must be alphanumeric and less than or equal to 32 characters and
- // greater than 0 characters in length.
- string finding_id = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The Finding being created. The name and security_marks will be
- // ignored as they are both output only fields on this resource.
- Finding finding = 3 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for creating a mute config.
- message CreateMuteConfigRequest {
- // Required. Resource name of the new mute configs's parent. Its format is
- // "organizations/[organization_id]", "folders/[folder_id]", or
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/MuteConfig"
- }
- ];
- // Required. The mute config being created.
- MuteConfig mute_config = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Unique identifier provided by the client within the parent scope.
- // It must consist of lower case letters, numbers, and hyphen, with the first
- // character a letter, the last a letter or a number, and a 63 character
- // maximum.
- string mute_config_id = 3 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for creating a notification config.
- message CreateNotificationConfigRequest {
- // Required. Resource name of the new notification config's parent. Its format
- // is "organizations/[organization_id]", "folders/[folder_id]", or
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/NotificationConfig"
- }
- ];
- // Required.
- // Unique identifier provided by the client within the parent scope.
- // It must be between 1 and 128 characters, and contains alphanumeric
- // characters, underscores or hyphens only.
- string config_id = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The notification config being created. The name and the service
- // account will be ignored as they are both output only fields on this
- // resource.
- NotificationConfig notification_config = 3
- [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for creating a source.
- message CreateSourceRequest {
- // Required. Resource name of the new source's parent. Its format should be
- // "organizations/[organization_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudresourcemanager.googleapis.com/Organization"
- }
- ];
- // Required. The Source being created, only the display_name and description
- // will be used. All other fields will be ignored.
- Source source = 2 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for deleting a mute config.
- message DeleteMuteConfigRequest {
- // Required. Name of the mute config to delete. Its format is
- // organizations/{organization}/muteConfigs/{config_id},
- // folders/{folder}/muteConfigs/{config_id}, or
- // projects/{project}/muteConfigs/{config_id}
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/MuteConfig"
- }
- ];
- }
- // Request message for deleting a notification config.
- message DeleteNotificationConfigRequest {
- // Required. Name of the notification config to delete. Its format is
- // "organizations/[organization_id]/notificationConfigs/[config_id]".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/NotificationConfig"
- }
- ];
- }
- // Request message for retrieving a big query export.
- message GetBigQueryExportRequest {
- // Required. Name of the big query export to retrieve. Its format is
- // organizations/{organization}/bigQueryExports/{export_id},
- // folders/{folder}/bigQueryExports/{export_id}, or
- // projects/{project}/bigQueryExports/{export_id}
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/BigQueryExport"
- }
- ];
- }
- // Request message for retrieving a mute config.
- message GetMuteConfigRequest {
- // Required. Name of the mute config to retrieve. Its format is
- // organizations/{organization}/muteConfigs/{config_id},
- // folders/{folder}/muteConfigs/{config_id}, or
- // projects/{project}/muteConfigs/{config_id}
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/MuteConfig"
- }
- ];
- }
- // Request message for getting a notification config.
- message GetNotificationConfigRequest {
- // Required. Name of the notification config to get. Its format is
- // "organizations/[organization_id]/notificationConfigs/[config_id]".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/NotificationConfig"
- }
- ];
- }
- // Request message for getting organization settings.
- message GetOrganizationSettingsRequest {
- // Required. Name of the organization to get organization settings for. Its
- // format is "organizations/[organization_id]/organizationSettings".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/OrganizationSettings"
- }
- ];
- }
- // Request message for getting a source.
- message GetSourceRequest {
- // Required. Relative resource name of the source. Its format is
- // "organizations/[organization_id]/source/[source_id]".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Source"
- }
- ];
- }
- // Request message for grouping by assets.
- message GroupAssetsRequest {
- // Required. Name of the organization to groupBy. Its format is
- // "organizations/[organization_id], folders/[folder_id], or
- // projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/Asset"
- }
- ];
- // Expression that defines the filter to apply across assets.
- // The expression is a list of zero or more restrictions combined via logical
- // operators `AND` and `OR`.
- // Parentheses are supported, and `OR` has higher precedence than `AND`.
- //
- // Restrictions have the form `<field> <operator> <value>` and may have a `-`
- // character in front of them to indicate negation. The fields map to those
- // defined in the Asset resource. Examples include:
- //
- // * name
- // * security_center_properties.resource_name
- // * resource_properties.a_property
- // * security_marks.marks.marka
- //
- // The supported operators are:
- //
- // * `=` for all value types.
- // * `>`, `<`, `>=`, `<=` for integer values.
- // * `:`, meaning substring matching, for strings.
- //
- // The supported value types are:
- //
- // * string literals in quotes.
- // * integer literals without quotes.
- // * boolean literals `true` and `false` without quotes.
- //
- // The following field and operator combinations are supported:
- //
- // * name: `=`
- // * update_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `update_time = "2019-06-10T16:07:18-07:00"`
- // `update_time = 1560208038000`
- //
- // * create_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `create_time = "2019-06-10T16:07:18-07:00"`
- // `create_time = 1560208038000`
- //
- // * iam_policy.policy_blob: `=`, `:`
- // * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
- // * security_marks.marks: `=`, `:`
- // * security_center_properties.resource_name: `=`, `:`
- // * security_center_properties.resource_display_name: `=`, `:`
- // * security_center_properties.resource_type: `=`, `:`
- // * security_center_properties.resource_parent: `=`, `:`
- // * security_center_properties.resource_parent_display_name: `=`, `:`
- // * security_center_properties.resource_project: `=`, `:`
- // * security_center_properties.resource_project_display_name: `=`, `:`
- // * security_center_properties.resource_owners: `=`, `:`
- //
- // For example, `resource_properties.size = 100` is a valid filter string.
- //
- // Use a partial match on the empty string to filter based on a property
- // existing: `resource_properties.my_property : ""`
- //
- // Use a negated partial match on the empty string to filter based on a
- // property not existing: `-resource_properties.my_property : ""`
- string filter = 2;
- // Required. Expression that defines what assets fields to use for grouping.
- // The string value should follow SQL syntax: comma separated list of fields.
- // For example:
- // "security_center_properties.resource_project,security_center_properties.project".
- //
- // The following fields are supported when compare_duration is not set:
- //
- // * security_center_properties.resource_project
- // * security_center_properties.resource_project_display_name
- // * security_center_properties.resource_type
- // * security_center_properties.resource_parent
- // * security_center_properties.resource_parent_display_name
- //
- // The following fields are supported when compare_duration is set:
- //
- // * security_center_properties.resource_type
- // * security_center_properties.resource_project_display_name
- // * security_center_properties.resource_parent_display_name
- string group_by = 3 [(google.api.field_behavior) = REQUIRED];
- // When compare_duration is set, the GroupResult's "state_change" property is
- // updated to indicate whether the asset was added, removed, or remained
- // present during the compare_duration period of time that precedes the
- // read_time. This is the time between (read_time - compare_duration) and
- // read_time.
- //
- // The state change value is derived based on the presence of the asset at the
- // two points in time. Intermediate state changes between the two times don't
- // affect the result. For example, the results aren't affected if the asset is
- // removed and re-created again.
- //
- // Possible "state_change" values when compare_duration is specified:
- //
- // * "ADDED": indicates that the asset was not present at the start of
- // compare_duration, but present at reference_time.
- // * "REMOVED": indicates that the asset was present at the start of
- // compare_duration, but not present at reference_time.
- // * "ACTIVE": indicates that the asset was present at both the
- // start and the end of the time period defined by
- // compare_duration and reference_time.
- //
- // If compare_duration is not specified, then the only possible state_change
- // is "UNUSED", which will be the state_change set for all assets present at
- // read_time.
- //
- // If this field is set then `state_change` must be a specified field in
- // `group_by`.
- google.protobuf.Duration compare_duration = 4;
- // Time used as a reference point when filtering assets. The filter is limited
- // to assets existing at the supplied time and their values are those at that
- // specific time. Absence of this field will default to the API's version of
- // NOW.
- google.protobuf.Timestamp read_time = 5;
- // The value returned by the last `GroupAssetsResponse`; indicates
- // that this is a continuation of a prior `GroupAssets` call, and that the
- // system should return the next page of data.
- string page_token = 7;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 8;
- }
- // Response message for grouping by assets.
- message GroupAssetsResponse {
- // Group results. There exists an element for each existing unique
- // combination of property/values. The element contains a count for the number
- // of times those specific property/values appear.
- repeated GroupResult group_by_results = 1;
- // Time used for executing the groupBy request.
- google.protobuf.Timestamp read_time = 2;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 3;
- // The total number of results matching the query.
- int32 total_size = 4;
- }
- // Request message for grouping by findings.
- message GroupFindingsRequest {
- // Required. Name of the source to groupBy. Its format is
- // "organizations/[organization_id]/sources/[source_id]",
- // folders/[folder_id]/sources/[source_id], or
- // projects/[project_id]/sources/[source_id]. To groupBy across all sources
- // provide a source_id of `-`. For example:
- // organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-,
- // or projects/{project_id}/sources/-
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Source"
- }
- ];
- // Expression that defines the filter to apply across findings.
- // The expression is a list of one or more restrictions combined via logical
- // operators `AND` and `OR`.
- // Parentheses are supported, and `OR` has higher precedence than `AND`.
- //
- // Restrictions have the form `<field> <operator> <value>` and may have a `-`
- // character in front of them to indicate negation. Examples include:
- //
- // * name
- // * source_properties.a_property
- // * security_marks.marks.marka
- //
- // The supported operators are:
- //
- // * `=` for all value types.
- // * `>`, `<`, `>=`, `<=` for integer values.
- // * `:`, meaning substring matching, for strings.
- //
- // The supported value types are:
- //
- // * string literals in quotes.
- // * integer literals without quotes.
- // * boolean literals `true` and `false` without quotes.
- //
- // The following field and operator combinations are supported:
- //
- // * name: `=`
- // * parent: `=`, `:`
- // * resource_name: `=`, `:`
- // * state: `=`, `:`
- // * category: `=`, `:`
- // * external_uri: `=`, `:`
- // * event_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `event_time = "2019-06-10T16:07:18-07:00"`
- // `event_time = 1560208038000`
- //
- // * severity: `=`, `:`
- // * workflow_state: `=`, `:`
- // * security_marks.marks: `=`, `:`
- // * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
- //
- // For example, `source_properties.size = 100` is a valid filter string.
- //
- // Use a partial match on the empty string to filter based on a property
- // existing: `source_properties.my_property : ""`
- //
- // Use a negated partial match on the empty string to filter based on a
- // property not existing: `-source_properties.my_property : ""`
- //
- // * resource:
- // * resource.name: `=`, `:`
- // * resource.parent_name: `=`, `:`
- // * resource.parent_display_name: `=`, `:`
- // * resource.project_name: `=`, `:`
- // * resource.project_display_name: `=`, `:`
- // * resource.type: `=`, `:`
- string filter = 2;
- // Required. Expression that defines what assets fields to use for grouping
- // (including `state_change`). The string value should follow SQL syntax:
- // comma separated list of fields. For example: "parent,resource_name".
- //
- // The following fields are supported:
- //
- // * resource_name
- // * category
- // * state
- // * parent
- // * severity
- //
- // The following fields are supported when compare_duration is set:
- //
- // * state_change
- string group_by = 3 [(google.api.field_behavior) = REQUIRED];
- // Time used as a reference point when filtering findings. The filter is
- // limited to findings existing at the supplied time and their values are
- // those at that specific time. Absence of this field will default to the
- // API's version of NOW.
- google.protobuf.Timestamp read_time = 4;
- // When compare_duration is set, the GroupResult's "state_change" attribute is
- // updated to indicate whether the finding had its state changed, the
- // finding's state remained unchanged, or if the finding was added during the
- // compare_duration period of time that precedes the read_time. This is the
- // time between (read_time - compare_duration) and read_time.
- //
- // The state_change value is derived based on the presence and state of the
- // finding at the two points in time. Intermediate state changes between the
- // two times don't affect the result. For example, the results aren't affected
- // if the finding is made inactive and then active again.
- //
- // Possible "state_change" values when compare_duration is specified:
- //
- // * "CHANGED": indicates that the finding was present and matched the given
- // filter at the start of compare_duration, but changed its
- // state at read_time.
- // * "UNCHANGED": indicates that the finding was present and matched the given
- // filter at the start of compare_duration and did not change
- // state at read_time.
- // * "ADDED": indicates that the finding did not match the given filter or
- // was not present at the start of compare_duration, but was
- // present at read_time.
- // * "REMOVED": indicates that the finding was present and matched the
- // filter at the start of compare_duration, but did not match
- // the filter at read_time.
- //
- // If compare_duration is not specified, then the only possible state_change
- // is "UNUSED", which will be the state_change set for all findings present
- // at read_time.
- //
- // If this field is set then `state_change` must be a specified field in
- // `group_by`.
- google.protobuf.Duration compare_duration = 5;
- // The value returned by the last `GroupFindingsResponse`; indicates
- // that this is a continuation of a prior `GroupFindings` call, and
- // that the system should return the next page of data.
- string page_token = 7;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 8;
- }
- // Response message for group by findings.
- message GroupFindingsResponse {
- // Group results. There exists an element for each existing unique
- // combination of property/values. The element contains a count for the number
- // of times those specific property/values appear.
- repeated GroupResult group_by_results = 1;
- // Time used for executing the groupBy request.
- google.protobuf.Timestamp read_time = 2;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 3;
- // The total number of results matching the query.
- int32 total_size = 4;
- }
- // Result containing the properties and count of a groupBy request.
- message GroupResult {
- // Properties matching the groupBy fields in the request.
- map<string, google.protobuf.Value> properties = 1;
- // Total count of resources for the given properties.
- int64 count = 2;
- }
- // Request message for listing mute configs at a given scope e.g. organization,
- // folder or project.
- message ListMuteConfigsRequest {
- // Required. The parent, which owns the collection of mute configs. Its format
- // is "organizations/[organization_id]", "folders/[folder_id]",
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/MuteConfig"
- }
- ];
- // The maximum number of configs to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 configs will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- int32 page_size = 2;
- // A page token, received from a previous `ListMuteConfigs` call.
- // Provide this to retrieve the subsequent page.
- //
- // When paginating, all other parameters provided to `ListMuteConfigs` must
- // match the call that provided the page token.
- string page_token = 3;
- }
- // Response message for listing mute configs.
- message ListMuteConfigsResponse {
- // The mute configs from the specified parent.
- repeated MuteConfig mute_configs = 1;
- // A token, which can be sent as `page_token` to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
- string next_page_token = 2;
- }
- // Request message for listing notification configs.
- message ListNotificationConfigsRequest {
- // Required. Name of the organization to list notification configs. Its format
- // is "organizations/[organization_id]", "folders/[folder_id]", or
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/NotificationConfig"
- }
- ];
- // The value returned by the last `ListNotificationConfigsResponse`; indicates
- // that this is a continuation of a prior `ListNotificationConfigs` call, and
- // that the system should return the next page of data.
- string page_token = 2;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 3;
- }
- // Response message for listing notification configs.
- message ListNotificationConfigsResponse {
- // Notification configs belonging to the requested parent.
- repeated NotificationConfig notification_configs = 1;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 2;
- }
- // Request message for listing sources.
- message ListSourcesRequest {
- // Required. Resource name of the parent of sources to list. Its format should
- // be "organizations/[organization_id], folders/[folder_id], or
- // projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/Source"
- }
- ];
- // The value returned by the last `ListSourcesResponse`; indicates
- // that this is a continuation of a prior `ListSources` call, and
- // that the system should return the next page of data.
- string page_token = 2;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 7;
- }
- // Response message for listing sources.
- message ListSourcesResponse {
- // Sources belonging to the requested parent.
- repeated Source sources = 1;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 2;
- }
- // Request message for listing assets.
- message ListAssetsRequest {
- // Required. Name of the organization assets should belong to. Its format is
- // "organizations/[organization_id], folders/[folder_id], or
- // projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/Asset"
- }
- ];
- // Expression that defines the filter to apply across assets.
- // The expression is a list of zero or more restrictions combined via logical
- // operators `AND` and `OR`.
- // Parentheses are supported, and `OR` has higher precedence than `AND`.
- //
- // Restrictions have the form `<field> <operator> <value>` and may have a `-`
- // character in front of them to indicate negation. The fields map to those
- // defined in the Asset resource. Examples include:
- //
- // * name
- // * security_center_properties.resource_name
- // * resource_properties.a_property
- // * security_marks.marks.marka
- //
- // The supported operators are:
- //
- // * `=` for all value types.
- // * `>`, `<`, `>=`, `<=` for integer values.
- // * `:`, meaning substring matching, for strings.
- //
- // The supported value types are:
- //
- // * string literals in quotes.
- // * integer literals without quotes.
- // * boolean literals `true` and `false` without quotes.
- //
- // The following are the allowed field and operator combinations:
- //
- // * name: `=`
- // * update_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `update_time = "2019-06-10T16:07:18-07:00"`
- // `update_time = 1560208038000`
- //
- // * create_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `create_time = "2019-06-10T16:07:18-07:00"`
- // `create_time = 1560208038000`
- //
- // * iam_policy.policy_blob: `=`, `:`
- // * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
- // * security_marks.marks: `=`, `:`
- // * security_center_properties.resource_name: `=`, `:`
- // * security_center_properties.resource_display_name: `=`, `:`
- // * security_center_properties.resource_type: `=`, `:`
- // * security_center_properties.resource_parent: `=`, `:`
- // * security_center_properties.resource_parent_display_name: `=`, `:`
- // * security_center_properties.resource_project: `=`, `:`
- // * security_center_properties.resource_project_display_name: `=`, `:`
- // * security_center_properties.resource_owners: `=`, `:`
- //
- // For example, `resource_properties.size = 100` is a valid filter string.
- //
- // Use a partial match on the empty string to filter based on a property
- // existing: `resource_properties.my_property : ""`
- //
- // Use a negated partial match on the empty string to filter based on a
- // property not existing: `-resource_properties.my_property : ""`
- string filter = 2;
- // Expression that defines what fields and order to use for sorting. The
- // string value should follow SQL syntax: comma separated list of fields. For
- // example: "name,resource_properties.a_property". The default sorting order
- // is ascending. To specify descending order for a field, a suffix " desc"
- // should be appended to the field name. For example: "name
- // desc,resource_properties.a_property". Redundant space characters in the
- // syntax are insignificant. "name desc,resource_properties.a_property" and "
- // name desc , resource_properties.a_property " are equivalent.
- //
- // The following fields are supported:
- // name
- // update_time
- // resource_properties
- // security_marks.marks
- // security_center_properties.resource_name
- // security_center_properties.resource_display_name
- // security_center_properties.resource_parent
- // security_center_properties.resource_parent_display_name
- // security_center_properties.resource_project
- // security_center_properties.resource_project_display_name
- // security_center_properties.resource_type
- string order_by = 3;
- // Time used as a reference point when filtering assets. The filter is limited
- // to assets existing at the supplied time and their values are those at that
- // specific time. Absence of this field will default to the API's version of
- // NOW.
- google.protobuf.Timestamp read_time = 4;
- // When compare_duration is set, the ListAssetsResult's "state_change"
- // attribute is updated to indicate whether the asset was added, removed, or
- // remained present during the compare_duration period of time that precedes
- // the read_time. This is the time between (read_time - compare_duration) and
- // read_time.
- //
- // The state_change value is derived based on the presence of the asset at the
- // two points in time. Intermediate state changes between the two times don't
- // affect the result. For example, the results aren't affected if the asset is
- // removed and re-created again.
- //
- // Possible "state_change" values when compare_duration is specified:
- //
- // * "ADDED": indicates that the asset was not present at the start of
- // compare_duration, but present at read_time.
- // * "REMOVED": indicates that the asset was present at the start of
- // compare_duration, but not present at read_time.
- // * "ACTIVE": indicates that the asset was present at both the
- // start and the end of the time period defined by
- // compare_duration and read_time.
- //
- // If compare_duration is not specified, then the only possible state_change
- // is "UNUSED", which will be the state_change set for all assets present at
- // read_time.
- google.protobuf.Duration compare_duration = 5;
- // A field mask to specify the ListAssetsResult fields to be listed in the
- // response.
- // An empty field mask will list all fields.
- google.protobuf.FieldMask field_mask = 7;
- // The value returned by the last `ListAssetsResponse`; indicates
- // that this is a continuation of a prior `ListAssets` call, and
- // that the system should return the next page of data.
- string page_token = 8;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 9;
- }
- // Response message for listing assets.
- message ListAssetsResponse {
- // Result containing the Asset and its State.
- message ListAssetsResult {
- // The change in state of the asset.
- //
- // When querying across two points in time this describes
- // the change between the two points: ADDED, REMOVED, or ACTIVE.
- // If there was no compare_duration supplied in the request the state change
- // will be: UNUSED
- enum StateChange {
- // State change is unused, this is the canonical default for this enum.
- UNUSED = 0;
- // Asset was added between the points in time.
- ADDED = 1;
- // Asset was removed between the points in time.
- REMOVED = 2;
- // Asset was present at both point(s) in time.
- ACTIVE = 3;
- }
- // Asset matching the search request.
- Asset asset = 1;
- // State change of the asset between the points in time.
- StateChange state_change = 2;
- }
- // Assets matching the list request.
- repeated ListAssetsResult list_assets_results = 1;
- // Time used for executing the list request.
- google.protobuf.Timestamp read_time = 2;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 3;
- // The total number of assets matching the query.
- int32 total_size = 4;
- }
- // Request message for listing findings.
- message ListFindingsRequest {
- // Required. Name of the source the findings belong to. Its format is
- // "organizations/[organization_id]/sources/[source_id],
- // folders/[folder_id]/sources/[source_id], or
- // projects/[project_id]/sources/[source_id]". To list across all sources
- // provide a source_id of `-`. For example:
- // organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
- // projects/{projects_id}/sources/-
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Source"
- }
- ];
- // Expression that defines the filter to apply across findings.
- // The expression is a list of one or more restrictions combined via logical
- // operators `AND` and `OR`.
- // Parentheses are supported, and `OR` has higher precedence than `AND`.
- //
- // Restrictions have the form `<field> <operator> <value>` and may have a `-`
- // character in front of them to indicate negation. Examples include:
- //
- // * name
- // * source_properties.a_property
- // * security_marks.marks.marka
- //
- // The supported operators are:
- //
- // * `=` for all value types.
- // * `>`, `<`, `>=`, `<=` for integer values.
- // * `:`, meaning substring matching, for strings.
- //
- // The supported value types are:
- //
- // * string literals in quotes.
- // * integer literals without quotes.
- // * boolean literals `true` and `false` without quotes.
- //
- // The following field and operator combinations are supported:
- //
- // * name: `=`
- // * parent: `=`, `:`
- // * resource_name: `=`, `:`
- // * state: `=`, `:`
- // * category: `=`, `:`
- // * external_uri: `=`, `:`
- // * event_time: `=`, `>`, `<`, `>=`, `<=`
- //
- // Usage: This should be milliseconds since epoch or an RFC3339 string.
- // Examples:
- // `event_time = "2019-06-10T16:07:18-07:00"`
- // `event_time = 1560208038000`
- //
- // * severity: `=`, `:`
- // * workflow_state: `=`, `:`
- // * security_marks.marks: `=`, `:`
- // * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
- //
- // For example, `source_properties.size = 100` is a valid filter string.
- //
- // Use a partial match on the empty string to filter based on a property
- // existing: `source_properties.my_property : ""`
- //
- // Use a negated partial match on the empty string to filter based on a
- // property not existing: `-source_properties.my_property : ""`
- //
- // * resource:
- // * resource.name: `=`, `:`
- // * resource.parent_name: `=`, `:`
- // * resource.parent_display_name: `=`, `:`
- // * resource.project_name: `=`, `:`
- // * resource.project_display_name: `=`, `:`
- // * resource.type: `=`, `:`
- // * resource.folders.resource_folder: `=`, `:`
- // * resource.display_name: `=`, `:`
- string filter = 2;
- // Expression that defines what fields and order to use for sorting. The
- // string value should follow SQL syntax: comma separated list of fields. For
- // example: "name,resource_properties.a_property". The default sorting order
- // is ascending. To specify descending order for a field, a suffix " desc"
- // should be appended to the field name. For example: "name
- // desc,source_properties.a_property". Redundant space characters in the
- // syntax are insignificant. "name desc,source_properties.a_property" and "
- // name desc , source_properties.a_property " are equivalent.
- //
- // The following fields are supported:
- // name
- // parent
- // state
- // category
- // resource_name
- // event_time
- // source_properties
- // security_marks.marks
- string order_by = 3;
- // Time used as a reference point when filtering findings. The filter is
- // limited to findings existing at the supplied time and their values are
- // those at that specific time. Absence of this field will default to the
- // API's version of NOW.
- google.protobuf.Timestamp read_time = 4;
- // When compare_duration is set, the ListFindingsResult's "state_change"
- // attribute is updated to indicate whether the finding had its state changed,
- // the finding's state remained unchanged, or if the finding was added in any
- // state during the compare_duration period of time that precedes the
- // read_time. This is the time between (read_time - compare_duration) and
- // read_time.
- //
- // The state_change value is derived based on the presence and state of the
- // finding at the two points in time. Intermediate state changes between the
- // two times don't affect the result. For example, the results aren't affected
- // if the finding is made inactive and then active again.
- //
- // Possible "state_change" values when compare_duration is specified:
- //
- // * "CHANGED": indicates that the finding was present and matched the given
- // filter at the start of compare_duration, but changed its
- // state at read_time.
- // * "UNCHANGED": indicates that the finding was present and matched the given
- // filter at the start of compare_duration and did not change
- // state at read_time.
- // * "ADDED": indicates that the finding did not match the given filter or
- // was not present at the start of compare_duration, but was
- // present at read_time.
- // * "REMOVED": indicates that the finding was present and matched the
- // filter at the start of compare_duration, but did not match
- // the filter at read_time.
- //
- // If compare_duration is not specified, then the only possible state_change
- // is "UNUSED", which will be the state_change set for all findings present at
- // read_time.
- google.protobuf.Duration compare_duration = 5;
- // A field mask to specify the Finding fields to be listed in the response.
- // An empty field mask will list all fields.
- google.protobuf.FieldMask field_mask = 7;
- // The value returned by the last `ListFindingsResponse`; indicates
- // that this is a continuation of a prior `ListFindings` call, and
- // that the system should return the next page of data.
- string page_token = 8;
- // The maximum number of results to return in a single response. Default is
- // 10, minimum is 1, maximum is 1000.
- int32 page_size = 9;
- }
- // Response message for listing findings.
- message ListFindingsResponse {
- // Result containing the Finding and its StateChange.
- message ListFindingsResult {
- // The change in state of the finding.
- //
- // When querying across two points in time this describes
- // the change in the finding between the two points: CHANGED, UNCHANGED,
- // ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that
- // the finding at timestamp does not match the filter specified, but it did
- // at timestamp - compare_duration. If there was no compare_duration
- // supplied in the request the state change will be: UNUSED
- enum StateChange {
- // State change is unused, this is the canonical default for this enum.
- UNUSED = 0;
- // The finding has changed state in some way between the points in time
- // and existed at both points.
- CHANGED = 1;
- // The finding has not changed state between the points in time and
- // existed at both points.
- UNCHANGED = 2;
- // The finding was created between the points in time.
- ADDED = 3;
- // The finding at timestamp does not match the filter specified, but it
- // did at timestamp - compare_duration.
- REMOVED = 4;
- }
- // Information related to the Google Cloud resource that is
- // associated with this finding.
- message Resource {
- // The full resource name of the resource. See:
- // https://cloud.google.com/apis/design/resource_names#full_resource_name
- string name = 1;
- // The human readable name of the resource.
- string display_name = 8;
- // The full resource type of the resource.
- string type = 6;
- // The full resource name of project that the resource belongs to.
- string project_name = 2;
- // The project ID that the resource belongs to.
- string project_display_name = 3;
- // The full resource name of resource's parent.
- string parent_name = 4;
- // The human readable name of resource's parent.
- string parent_display_name = 5;
- // Contains a Folder message for each folder in the assets ancestry.
- // The first folder is the deepest nested folder, and the last folder is
- // the folder directly under the Organization.
- repeated Folder folders = 7;
- }
- // Finding matching the search request.
- Finding finding = 1;
- // State change of the finding between the points in time.
- StateChange state_change = 2;
- // Output only. Resource that is associated with this finding.
- Resource resource = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
- // Findings matching the list request.
- repeated ListFindingsResult list_findings_results = 1;
- // Time used for executing the list request.
- google.protobuf.Timestamp read_time = 2;
- // Token to retrieve the next page of results, or empty if there are no more
- // results.
- string next_page_token = 3;
- // The total number of findings matching the query.
- int32 total_size = 4;
- }
- // Request message for updating a finding's state.
- message SetFindingStateRequest {
- // Required. The relative resource name of the finding. See:
- // https://cloud.google.com/apis/design/resource_names#relative_resource_name
- // Example:
- // "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Finding"
- }
- ];
- // Required. The desired State of the finding.
- Finding.State state = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. The time at which the updated state takes effect.
- google.protobuf.Timestamp start_time = 3
- [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for updating a finding's mute status.
- message SetMuteRequest {
- // Required. The relative resource name of the finding. See:
- // https://cloud.google.com/apis/design/resource_names#relative_resource_name
- // Example:
- // "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}",
- // "folders/{folder_id}/sources/{source_id}/findings/{finding_id}",
- // "projects/{project_id}/sources/{source_id}/findings/{finding_id}".
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/Finding"
- }
- ];
- // Required. The desired state of the Mute.
- Finding.Mute mute = 2 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for running asset discovery for an organization.
- message RunAssetDiscoveryRequest {
- // Required. Name of the organization to run asset discovery for. Its format
- // is "organizations/[organization_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudresourcemanager.googleapis.com/Organization"
- }
- ];
- }
- // Request message for updating a ExternalSystem resource.
- message UpdateExternalSystemRequest {
- // Required. The external system resource to update.
- ExternalSystem external_system = 1 [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the external system resource.
- //
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating or creating a finding.
- message UpdateFindingRequest {
- // Required. The finding resource to update or create if it does not already
- // exist. parent, security_marks, and update_time will be ignored.
- //
- // In the case of creation, the finding id portion of the name must be
- // alphanumeric and less than or equal to 32 characters and greater than 0
- // characters in length.
- Finding finding = 1 [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the finding resource. This field should
- // not be specified when creating a finding.
- //
- // When updating a finding, an empty mask is treated as updating all mutable
- // fields and replacing source_properties. Individual source_properties can
- // be added/updated by using "source_properties.<property key>" in the field
- // mask.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating a mute config.
- message UpdateMuteConfigRequest {
- // Required. The mute config being updated.
- MuteConfig mute_config = 1 [(google.api.field_behavior) = REQUIRED];
- // The list of fields to be updated.
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating a notification config.
- message UpdateNotificationConfigRequest {
- // Required. The notification config to update.
- NotificationConfig notification_config = 1
- [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the notification config.
- //
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating an organization's settings.
- message UpdateOrganizationSettingsRequest {
- // Required. The organization settings resource to update.
- OrganizationSettings organization_settings = 1
- [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the settings resource.
- //
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating a source.
- message UpdateSourceRequest {
- // Required. The source resource to update.
- Source source = 1 [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the source resource.
- //
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for updating a SecurityMarks resource.
- message UpdateSecurityMarksRequest {
- // Required. The security marks resource to update.
- SecurityMarks security_marks = 1 [(google.api.field_behavior) = REQUIRED];
- // The FieldMask to use when updating the security marks resource.
- //
- // The field mask must not contain duplicate fields.
- // If empty or set to "marks", all marks will be replaced. Individual
- // marks can be updated using "marks.<mark_key>".
- google.protobuf.FieldMask update_mask = 2;
- // The time at which the updated SecurityMarks take effect.
- // If not set uses current server time. Updates will be applied to the
- // SecurityMarks that are active immediately preceding this time. Must be
- // earlier or equal to the server time.
- google.protobuf.Timestamp start_time = 3;
- }
- // Request message for creating a big query export.
- message CreateBigQueryExportRequest {
- // Required. Resource name of the new big query export's parent. Its format is
- // "organizations/[organization_id]", "folders/[folder_id]", or
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/BigQueryExport"
- }
- ];
- // Required. The big query export being created.
- BigQueryExport big_query_export = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. Unique identifier provided by the client within the parent scope.
- // It must consist of lower case letters, numbers, and hyphen, with the first
- // character a letter, the last a letter or a number, and a 63 character
- // maximum.
- string big_query_export_id = 3 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for updating a BigQuery export.
- message UpdateBigQueryExportRequest {
- // Required. The BigQuery export being updated.
- BigQueryExport big_query_export = 1 [(google.api.field_behavior) = REQUIRED];
- // The list of fields to be updated.
- // If empty all mutable fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
- }
- // Request message for listing BigQuery exports at a given scope e.g.
- // organization, folder or project.
- message ListBigQueryExportsRequest {
- // Required. The parent, which owns the collection of BigQuery exports. Its
- // format is "organizations/[organization_id]", "folders/[folder_id]",
- // "projects/[project_id]".
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "securitycenter.googleapis.com/BigQueryExport"
- }
- ];
- // The maximum number of configs to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 configs will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- int32 page_size = 2;
- // A page token, received from a previous `ListBigQueryExports` call.
- // Provide this to retrieve the subsequent page.
- // When paginating, all other parameters provided to `ListBigQueryExports`
- // must match the call that provided the page token.
- string page_token = 3;
- }
- // Response message for listing BigQuery exports.
- message ListBigQueryExportsResponse {
- // The BigQuery exports from the specified parent.
- repeated BigQueryExport big_query_exports = 1;
- // A token, which can be sent as `page_token` to retrieve the next page.
- // If this field is omitted, there are no subsequent pages.
- string next_page_token = 2;
- }
- // Request message for deleting a big query export.
- message DeleteBigQueryExportRequest {
- // Required. Name of the big query export to delete. Its format is
- // organizations/{organization}/bigQueryExports/{export_id},
- // folders/{folder}/bigQueryExports/{export_id}, or
- // projects/{project}/bigQueryExports/{export_id}
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "securitycenter.googleapis.com/BigQueryExport"
- }
- ];
- }
|