Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

SecurityCenter

import { SecurityCenter } from "https://googleapis.deno.dev/v1/securitycenter:v1.ts";

Security Command Center API provides access to temporal views of assets and findings within an organization.

class SecurityCenter {
constructor(client?: CredentialsClient, baseUrl?: string);
async foldersAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>;
async foldersAssetsList(parent: string, opts?: FoldersAssetsListOptions): Promise<ListAssetsResponse>;
async foldersAssetsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async foldersBigQueryExportsDelete(name: string): Promise<Empty>;
async foldersBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>;
async foldersBigQueryExportsList(parent: string, opts?: FoldersBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>;
async foldersEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>;
async foldersEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>;
async foldersEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>;
async foldersEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: FoldersEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>;
async foldersEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: FoldersEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>;
async foldersEventThreatDetectionSettingsCustomModulesPatch(
name: string,
): Promise<EventThreatDetectionCustomModule>;
async foldersEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>;
async foldersEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: FoldersEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>;
async foldersEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>;
async foldersFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>;
async foldersLocationsMuteConfigsDelete(name: string): Promise<Empty>;
async foldersLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async foldersLocationsMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async foldersMuteConfigsCreate(
parent: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async foldersMuteConfigsDelete(name: string): Promise<Empty>;
async foldersMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async foldersMuteConfigsList(parent: string, opts?: FoldersMuteConfigsListOptions): Promise<ListMuteConfigsResponse>;
async foldersMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async foldersNotificationConfigsCreate(
parent: string,
): Promise<NotificationConfig>;
async foldersNotificationConfigsDelete(name: string): Promise<Empty>;
async foldersNotificationConfigsGet(name: string): Promise<NotificationConfig>;
async foldersNotificationConfigsList(parent: string, opts?: FoldersNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>;
async foldersNotificationConfigsPatch(
name: string,
): Promise<NotificationConfig>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>;
async foldersSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>;
async foldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>;
async foldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>;
async foldersSourcesFindingsExternalSystemsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1ExternalSystem>;
async foldersSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>;
async foldersSourcesFindingsList(parent: string, opts?: FoldersSourcesFindingsListOptions): Promise<ListFindingsResponse>;
async foldersSourcesFindingsPatch(
name: string,
req: Finding,
): Promise<Finding>;
async foldersSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>;
async foldersSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>;
async foldersSourcesFindingsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async foldersSourcesList(parent: string, opts?: FoldersSourcesListOptions): Promise<ListSourcesResponse>;
async organizationsAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>;
async organizationsAssetsList(parent: string, opts?: OrganizationsAssetsListOptions): Promise<ListAssetsResponse>;
async organizationsAssetsRunDiscovery(parent: string, req: RunAssetDiscoveryRequest): Promise<Operation>;
async organizationsAssetsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async organizationsBigQueryExportsCreate(
parent: string,
): Promise<GoogleCloudSecuritycenterV1BigQueryExport>;
async organizationsBigQueryExportsDelete(name: string): Promise<Empty>;
async organizationsBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>;
async organizationsBigQueryExportsList(parent: string, opts?: OrganizationsBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>;
async organizationsEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>;
async organizationsEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>;
async organizationsEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>;
async organizationsEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: OrganizationsEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>;
async organizationsEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: OrganizationsEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>;
async organizationsEventThreatDetectionSettingsCustomModulesPatch(
name: string,
): Promise<EventThreatDetectionCustomModule>;
async organizationsEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>;
async organizationsEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: OrganizationsEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>;
async organizationsEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>;
async organizationsFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>;
async organizationsGetOrganizationSettings(name: string): Promise<OrganizationSettings>;
async organizationsLocationsMuteConfigsDelete(name: string): Promise<Empty>;
async organizationsLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async organizationsLocationsMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async organizationsMuteConfigsCreate(
parent: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async organizationsMuteConfigsDelete(name: string): Promise<Empty>;
async organizationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async organizationsMuteConfigsList(parent: string, opts?: OrganizationsMuteConfigsListOptions): Promise<ListMuteConfigsResponse>;
async organizationsMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async organizationsNotificationConfigsCreate(
parent: string,
): Promise<NotificationConfig>;
async organizationsNotificationConfigsDelete(name: string): Promise<Empty>;
async organizationsNotificationConfigsGet(name: string): Promise<NotificationConfig>;
async organizationsNotificationConfigsList(parent: string, opts?: OrganizationsNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>;
async organizationsNotificationConfigsPatch(
name: string,
): Promise<NotificationConfig>;
async organizationsOperationsCancel(name: string): Promise<Empty>;
async organizationsOperationsDelete(name: string): Promise<Empty>;
async organizationsOperationsGet(name: string): Promise<Operation>;
async organizationsOperationsList(name: string, opts?: OrganizationsOperationsListOptions): Promise<ListOperationsResponse>;
async organizationsResourceValueConfigsBatchCreate(parent: string, req: BatchCreateResourceValueConfigsRequest): Promise<BatchCreateResourceValueConfigsResponse>;
async organizationsResourceValueConfigsDelete(name: string): Promise<Empty>;
async organizationsResourceValueConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1ResourceValueConfig>;
async organizationsResourceValueConfigsList(parent: string, opts?: OrganizationsResourceValueConfigsListOptions): Promise<ListResourceValueConfigsResponse>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>;
async organizationsSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>;
async organizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>;
async organizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>;
async organizationsSimulationsAttackExposureResultsAttackPathsList(parent: string, opts?: OrganizationsSimulationsAttackExposureResultsAttackPathsListOptions): Promise<ListAttackPathsResponse>;
async organizationsSimulationsAttackExposureResultsValuedResourcesList(parent: string, opts?: OrganizationsSimulationsAttackExposureResultsValuedResourcesListOptions): Promise<ListValuedResourcesResponse>;
async organizationsSimulationsAttackPathsList(parent: string, opts?: OrganizationsSimulationsAttackPathsListOptions): Promise<ListAttackPathsResponse>;
async organizationsSimulationsGet(name: string): Promise<Simulation>;
async organizationsSimulationsValuedResourcesAttackPathsList(parent: string, opts?: OrganizationsSimulationsValuedResourcesAttackPathsListOptions): Promise<ListAttackPathsResponse>;
async organizationsSimulationsValuedResourcesGet(name: string): Promise<ValuedResource>;
async organizationsSimulationsValuedResourcesList(parent: string, opts?: OrganizationsSimulationsValuedResourcesListOptions): Promise<ListValuedResourcesResponse>;
async organizationsSourcesCreate(parent: string, req: Source): Promise<Source>;
async organizationsSourcesFindingsCreate(
parent: string,
req: Finding,
): Promise<Finding>;
async organizationsSourcesFindingsExternalSystemsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1ExternalSystem>;
async organizationsSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>;
async organizationsSourcesFindingsList(parent: string, opts?: OrganizationsSourcesFindingsListOptions): Promise<ListFindingsResponse>;
async organizationsSourcesFindingsPatch(
name: string,
req: Finding,
): Promise<Finding>;
async organizationsSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>;
async organizationsSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>;
async organizationsSourcesFindingsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async organizationsSourcesGet(name: string): Promise<Source>;
async organizationsSourcesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;
async organizationsSourcesList(parent: string, opts?: OrganizationsSourcesListOptions): Promise<ListSourcesResponse>;
async organizationsSourcesPatch(
name: string,
req: Source,
): Promise<Source>;
async organizationsSourcesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async organizationsSourcesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async organizationsUpdateOrganizationSettings(
name: string,
): Promise<OrganizationSettings>;
async projectsAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>;
async projectsAssetsList(parent: string, opts?: ProjectsAssetsListOptions): Promise<ListAssetsResponse>;
async projectsAssetsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async projectsBigQueryExportsDelete(name: string): Promise<Empty>;
async projectsBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>;
async projectsBigQueryExportsList(parent: string, opts?: ProjectsBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>;
async projectsEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>;
async projectsEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>;
async projectsEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>;
async projectsEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: ProjectsEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>;
async projectsEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: ProjectsEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>;
async projectsEventThreatDetectionSettingsCustomModulesPatch(
name: string,
): Promise<EventThreatDetectionCustomModule>;
async projectsEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>;
async projectsEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: ProjectsEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>;
async projectsEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>;
async projectsFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>;
async projectsLocationsMuteConfigsDelete(name: string): Promise<Empty>;
async projectsLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async projectsLocationsMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async projectsMuteConfigsCreate(
parent: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async projectsMuteConfigsDelete(name: string): Promise<Empty>;
async projectsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async projectsMuteConfigsList(parent: string, opts?: ProjectsMuteConfigsListOptions): Promise<ListMuteConfigsResponse>;
async projectsMuteConfigsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1MuteConfig>;
async projectsNotificationConfigsCreate(
parent: string,
): Promise<NotificationConfig>;
async projectsNotificationConfigsDelete(name: string): Promise<Empty>;
async projectsNotificationConfigsGet(name: string): Promise<NotificationConfig>;
async projectsNotificationConfigsList(parent: string, opts?: ProjectsNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>;
async projectsNotificationConfigsPatch(
name: string,
): Promise<NotificationConfig>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>;
async projectsSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>;
async projectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>;
async projectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>;
async projectsSourcesFindingsExternalSystemsPatch(
name: string,
): Promise<GoogleCloudSecuritycenterV1ExternalSystem>;
async projectsSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>;
async projectsSourcesFindingsList(parent: string, opts?: ProjectsSourcesFindingsListOptions): Promise<ListFindingsResponse>;
async projectsSourcesFindingsPatch(
name: string,
req: Finding,
): Promise<Finding>;
async projectsSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>;
async projectsSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>;
async projectsSourcesFindingsUpdateSecurityMarks(
name: string,
): Promise<SecurityMarks>;
async projectsSourcesList(parent: string, opts?: ProjectsSourcesListOptions): Promise<ListSourcesResponse>;
}

§Constructors

§
new SecurityCenter(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
foldersAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>
[src]

Filters an organization's assets and groups them by their specified properties.

@param parent

Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersAssetsList(parent: string, opts?: FoldersAssetsListOptions): Promise<ListAssetsResponse>
[src]

Lists an organization's assets.

@param parent

Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersAssetsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: FoldersAssetsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§

Creates a BigQuery export.

@param parent

Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersBigQueryExportsDelete(name: string): Promise<Empty>
[src]

Deletes an existing BigQuery export.

@param name

Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
foldersBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>
[src]

Gets a BigQuery export.

@param name

Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
foldersBigQueryExportsList(parent: string, opts?: FoldersBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>
[src]

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.

@param parent

Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a BigQuery export.

@param name

The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.

§
foldersEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>
[src]

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

@param parent

Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
foldersEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
foldersEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>
[src]

Gets an Event Threat Detection custom module.

@param name

Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
foldersEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: FoldersEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>
[src]

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
foldersEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: FoldersEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>
[src]

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
foldersEventThreatDetectionSettingsCustomModulesPatch(name: string, req: EventThreatDetectionCustomModule, opts?: FoldersEventThreatDetectionSettingsCustomModulesPatchOptions): Promise<EventThreatDetectionCustomModule>
[src]

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

@param name

Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
foldersEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>
[src]

Gets an effective Event Threat Detection custom module at the given level.

@param name

Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".

§
foldersEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: FoldersEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>
[src]

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

@param parent

Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
foldersEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>
[src]

Validates the given Event Threat Detection custom module.

@param parent

Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
foldersFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>
[src]

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.

@param parent

Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§
foldersLocationsMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
foldersLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§

Creates a mute config.

@param parent

Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
foldersMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
foldersMuteConfigsList(parent: string, opts?: FoldersMuteConfigsListOptions): Promise<ListMuteConfigsResponse>
[src]

Lists mute configs.

@param parent

Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§
foldersNotificationConfigsCreate(parent: string, req: NotificationConfig, opts?: FoldersNotificationConfigsCreateOptions): Promise<NotificationConfig>
[src]

Creates a notification config.

@param parent

Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersNotificationConfigsDelete(name: string): Promise<Empty>
[src]

Deletes a notification config.

@param name

Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
foldersNotificationConfigsGet(name: string): Promise<NotificationConfig>
[src]

Gets a notification config.

@param name

Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
foldersNotificationConfigsList(parent: string, opts?: FoldersNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>
[src]

Lists notification configs.

@param parent

Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
foldersNotificationConfigsPatch(name: string, req: NotificationConfig, opts?: FoldersNotificationConfigsPatchOptions): Promise<NotificationConfig>
[src]

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

@param name

The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".

§
foldersSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

@param parent

Required. Resource name of the new custom module's parent. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
foldersSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
foldersSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Retrieves a SecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
foldersSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
foldersSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

@param parent

Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

@param name

Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

§
foldersSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>
[src]

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

@param parent

Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example: organizations/{organization_id}

§
foldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>
[src]

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the effective custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

§
foldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: FoldersSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list effective custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§

Updates external system. This is for a given finding.

@param name

Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"

§
foldersSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>
[src]

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

@param parent

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/-

§
foldersSourcesFindingsList(parent: string, opts?: FoldersSourcesFindingsListOptions): Promise<ListFindingsResponse>
[src]

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

@param parent

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/-

§
foldersSourcesFindingsPatch(name: string, req: Finding, opts?: FoldersSourcesFindingsPatchOptions): Promise<Finding>
[src]

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

@param name

The relative resource name of the finding. 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}".

§
foldersSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>
[src]

Updates the mute state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
foldersSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>
[src]

Updates the state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
foldersSourcesFindingsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: FoldersSourcesFindingsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§
foldersSourcesList(parent: string, opts?: FoldersSourcesListOptions): Promise<ListSourcesResponse>
[src]

Lists all sources belonging to an organization.

@param parent

Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>
[src]

Filters an organization's assets and groups them by their specified properties.

@param parent

Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsAssetsList(parent: string, opts?: OrganizationsAssetsListOptions): Promise<ListAssetsResponse>
[src]

Lists an organization's assets.

@param parent

Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsAssetsRunDiscovery(parent: string, req: RunAssetDiscoveryRequest): Promise<Operation>
[src]

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.

@param parent

Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]".

§
organizationsAssetsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: OrganizationsAssetsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§

Creates a BigQuery export.

@param parent

Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsBigQueryExportsDelete(name: string): Promise<Empty>
[src]

Deletes an existing BigQuery export.

@param name

Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
organizationsBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>
[src]

Gets a BigQuery export.

@param name

Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
organizationsBigQueryExportsList(parent: string, opts?: OrganizationsBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>
[src]

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.

@param parent

Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a BigQuery export.

@param name

The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.

§
organizationsEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>
[src]

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

@param parent

Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
organizationsEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
organizationsEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>
[src]

Gets an Event Threat Detection custom module.

@param name

Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
organizationsEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: OrganizationsEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>
[src]

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
organizationsEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: OrganizationsEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>
[src]

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
organizationsEventThreatDetectionSettingsCustomModulesPatch(name: string, req: EventThreatDetectionCustomModule, opts?: OrganizationsEventThreatDetectionSettingsCustomModulesPatchOptions): Promise<EventThreatDetectionCustomModule>
[src]

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

@param name

Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
organizationsEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>
[src]

Gets an effective Event Threat Detection custom module at the given level.

@param name

Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".

§
organizationsEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: OrganizationsEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>
[src]

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

@param parent

Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
organizationsEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>
[src]

Validates the given Event Threat Detection custom module.

@param parent

Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
organizationsFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>
[src]

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.

@param parent

Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§
organizationsGetOrganizationSettings(name: string): Promise<OrganizationSettings>
[src]

Gets the settings for an organization.

@param name

Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings".

§
organizationsLocationsMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
organizationsLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§

Creates a mute config.

@param parent

Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
organizationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
organizationsMuteConfigsList(parent: string, opts?: OrganizationsMuteConfigsListOptions): Promise<ListMuteConfigsResponse>
[src]

Lists mute configs.

@param parent

Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§
organizationsNotificationConfigsCreate(parent: string, req: NotificationConfig, opts?: OrganizationsNotificationConfigsCreateOptions): Promise<NotificationConfig>
[src]

Creates a notification config.

@param parent

Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsNotificationConfigsDelete(name: string): Promise<Empty>
[src]

Deletes a notification config.

@param name

Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
organizationsNotificationConfigsGet(name: string): Promise<NotificationConfig>
[src]

Gets a notification config.

@param name

Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
organizationsNotificationConfigsList(parent: string, opts?: OrganizationsNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>
[src]

Lists notification configs.

@param parent

Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsNotificationConfigsPatch(name: string, req: NotificationConfig, opts?: OrganizationsNotificationConfigsPatchOptions): Promise<NotificationConfig>
[src]

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

@param name

The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".

§
organizationsOperationsCancel(name: string): Promise<Empty>
[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
organizationsOperationsDelete(name: string): Promise<Empty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
organizationsOperationsGet(name: string): Promise<Operation>
[src]

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.

@param name

The name of the operation resource.

§
organizationsOperationsList(name: string, opts?: OrganizationsOperationsListOptions): Promise<ListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
organizationsResourceValueConfigsBatchCreate(parent: string, req: BatchCreateResourceValueConfigsRequest): Promise<BatchCreateResourceValueConfigsResponse>
[src]

Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation.

@param parent

Required. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.

§
organizationsResourceValueConfigsDelete(name: string): Promise<Empty>
[src]

Deletes a ResourceValueConfig.

@param name

Required. Name of the ResourceValueConfig to delete

§
organizationsResourceValueConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1ResourceValueConfig>
[src]

Gets a ResourceValueConfig.

@param name

Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.

§
organizationsResourceValueConfigsList(parent: string, opts?: OrganizationsResourceValueConfigsListOptions): Promise<ListResourceValueConfigsResponse>
[src]

Lists all ResourceValueConfigs.

@param parent

Required. The parent, which owns the collection of resource value configs. Its format is "organizations/[organization_id]"

§

Updates an existing ResourceValueConfigs with new rules.

@param name

Name for the resource value config

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

@param parent

Required. Resource name of the new custom module's parent. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Retrieves a SecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

@param parent

Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

@param name

Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

§
organizationsSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>
[src]

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

@param parent

Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example: organizations/{organization_id}

§
organizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>
[src]

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the effective custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

§
organizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: OrganizationsSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list effective custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
organizationsSimulationsAttackExposureResultsAttackPathsList(parent: string, opts?: OrganizationsSimulationsAttackExposureResultsAttackPathsListOptions): Promise<ListAttackPathsResponse>
[src]

Lists the attack paths for a set of simulation results or valued resources and filter.

@param parent

Required. Name of parent to list attack paths. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

§
organizationsSimulationsAttackExposureResultsValuedResourcesList(parent: string, opts?: OrganizationsSimulationsAttackExposureResultsValuedResourcesListOptions): Promise<ListValuedResourcesResponse>
[src]

Lists the valued resources for a set of simulation results and filter.

@param parent

Required. Name of parent to list valued resources. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"

§
organizationsSimulationsAttackPathsList(parent: string, opts?: OrganizationsSimulationsAttackPathsListOptions): Promise<ListAttackPathsResponse>
[src]

Lists the attack paths for a set of simulation results or valued resources and filter.

@param parent

Required. Name of parent to list attack paths. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

§
organizationsSimulationsGet(name: string): Promise<Simulation>
[src]

Get the simulation by name or the latest simulation for the given organization.

@param name

Required. The organization name or simulation name of this simulation Valid format: "organizations/{organization}/simulations/latest" "organizations/{organization}/simulations/{simulation}"

§
organizationsSimulationsValuedResourcesAttackPathsList(parent: string, opts?: OrganizationsSimulationsValuedResourcesAttackPathsListOptions): Promise<ListAttackPathsResponse>
[src]

Lists the attack paths for a set of simulation results or valued resources and filter.

@param parent

Required. Name of parent to list attack paths. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}" "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

§
organizationsSimulationsValuedResourcesGet(name: string): Promise<ValuedResource>
[src]

Get the valued resource by name

@param name

Required. The name of this valued resource Valid format: "organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}"

§
organizationsSimulationsValuedResourcesList(parent: string, opts?: OrganizationsSimulationsValuedResourcesListOptions): Promise<ListValuedResourcesResponse>
[src]

Lists the valued resources for a set of simulation results and filter.

@param parent

Required. Name of parent to list valued resources. Valid formats: "organizations/{organization}", "organizations/{organization}/simulations/{simulation}" "organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}"

§
organizationsSourcesCreate(parent: string, req: Source): Promise<Source>
[src]

Creates a source.

@param parent

Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]".

§
organizationsSourcesFindingsCreate(parent: string, req: Finding, opts?: OrganizationsSourcesFindingsCreateOptions): Promise<Finding>
[src]

Creates a finding. The corresponding source must exist for finding creation to succeed.

@param parent

Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]".

§

Updates external system. This is for a given finding.

@param name

Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"

§
organizationsSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>
[src]

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

@param parent

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/-

§
organizationsSourcesFindingsList(parent: string, opts?: OrganizationsSourcesFindingsListOptions): Promise<ListFindingsResponse>
[src]

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

@param parent

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/-

§
organizationsSourcesFindingsPatch(name: string, req: Finding, opts?: OrganizationsSourcesFindingsPatchOptions): Promise<Finding>
[src]

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

@param name

The relative resource name of the finding. 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}".

§
organizationsSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>
[src]

Updates the mute state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
organizationsSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>
[src]

Updates the state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
organizationsSourcesFindingsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: OrganizationsSourcesFindingsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§
organizationsSourcesGet(name: string): Promise<Source>
[src]

Gets a source.

@param name

Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]".

§
organizationsSourcesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>
[src]

Gets the access control policy on the specified Source.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
organizationsSourcesList(parent: string, opts?: OrganizationsSourcesListOptions): Promise<ListSourcesResponse>
[src]

Lists all sources belonging to an organization.

@param parent

Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
organizationsSourcesPatch(name: string, req: Source, opts?: OrganizationsSourcesPatchOptions): Promise<Source>
[src]

Updates a source.

@param name

The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}"

§
organizationsSourcesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified Source.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
organizationsSourcesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

Returns the permissions that a caller has on the specified source.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
organizationsUpdateOrganizationSettings(name: string, req: OrganizationSettings, opts?: OrganizationsUpdateOrganizationSettingsOptions): Promise<OrganizationSettings>
[src]

Updates an organization's settings.

@param name

The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings".

§
projectsAssetsGroup(parent: string, req: GroupAssetsRequest): Promise<GroupAssetsResponse>
[src]

Filters an organization's assets and groups them by their specified properties.

@param parent

Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsAssetsList(parent: string, opts?: ProjectsAssetsListOptions): Promise<ListAssetsResponse>
[src]

Lists an organization's assets.

@param parent

Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsAssetsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: ProjectsAssetsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§

Creates a BigQuery export.

@param parent

Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsBigQueryExportsDelete(name: string): Promise<Empty>
[src]

Deletes an existing BigQuery export.

@param name

Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
projectsBigQueryExportsGet(name: string): Promise<GoogleCloudSecuritycenterV1BigQueryExport>
[src]

Gets a BigQuery export.

@param name

Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}

§
projectsBigQueryExportsList(parent: string, opts?: ProjectsBigQueryExportsListOptions): Promise<ListBigQueryExportsResponse>
[src]

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.

@param parent

Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a BigQuery export.

@param name

The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests.

§
projectsEventThreatDetectionSettingsCustomModulesCreate(parent: string, req: EventThreatDetectionCustomModule): Promise<EventThreatDetectionCustomModule>
[src]

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.

@param parent

Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
projectsEventThreatDetectionSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
projectsEventThreatDetectionSettingsCustomModulesGet(name: string): Promise<EventThreatDetectionCustomModule>
[src]

Gets an Event Threat Detection custom module.

@param name

Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
projectsEventThreatDetectionSettingsCustomModulesList(parent: string, opts?: ProjectsEventThreatDetectionSettingsCustomModulesListOptions): Promise<ListEventThreatDetectionCustomModulesResponse>
[src]

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
projectsEventThreatDetectionSettingsCustomModulesListDescendant(parent: string, opts?: ProjectsEventThreatDetectionSettingsCustomModulesListDescendantOptions): Promise<ListDescendantEventThreatDetectionCustomModulesResponse>
[src]

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

@param parent

Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
projectsEventThreatDetectionSettingsCustomModulesPatch(name: string, req: EventThreatDetectionCustomModule, opts?: ProjectsEventThreatDetectionSettingsCustomModulesPatchOptions): Promise<EventThreatDetectionCustomModule>
[src]

Updates the Event Threat Detection custom module with the given name based on the given update mask. Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

@param name

Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".

§
projectsEventThreatDetectionSettingsEffectiveCustomModulesGet(name: string): Promise<EffectiveEventThreatDetectionCustomModule>
[src]

Gets an effective Event Threat Detection custom module at the given level.

@param name

Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}".

§
projectsEventThreatDetectionSettingsEffectiveCustomModulesList(parent: string, opts?: ProjectsEventThreatDetectionSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveEventThreatDetectionCustomModulesResponse>
[src]

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

@param parent

Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
projectsEventThreatDetectionSettingsValidateCustomModule(parent: string, req: ValidateEventThreatDetectionCustomModuleRequest): Promise<ValidateEventThreatDetectionCustomModuleResponse>
[src]

Validates the given Event Threat Detection custom module.

@param parent

Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings".

§
projectsFindingsBulkMute(parent: string, req: BulkMuteFindingsRequest): Promise<Operation>
[src]

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.

@param parent

Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§
projectsLocationsMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
projectsLocationsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§

Creates a mute config.

@param parent

Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsMuteConfigsDelete(name: string): Promise<Empty>
[src]

Deletes an existing mute config.

@param name

Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
projectsMuteConfigsGet(name: string): Promise<GoogleCloudSecuritycenterV1MuteConfig>
[src]

Gets a mute config.

@param name

Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.

§
projectsMuteConfigsList(parent: string, opts?: ProjectsMuteConfigsListOptions): Promise<ListMuteConfigsResponse>
[src]

Lists mute configs.

@param parent

Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]".

§

Updates a mute config.

@param name

This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" "organizations/{organization}/locations/global/muteConfigs/{mute_config}" "folders/{folder}/locations/global/muteConfigs/{mute_config}" "projects/{project}/locations/global/muteConfigs/{mute_config}"

§
projectsNotificationConfigsCreate(parent: string, req: NotificationConfig, opts?: ProjectsNotificationConfigsCreateOptions): Promise<NotificationConfig>
[src]

Creates a notification config.

@param parent

Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsNotificationConfigsDelete(name: string): Promise<Empty>
[src]

Deletes a notification config.

@param name

Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
projectsNotificationConfigsGet(name: string): Promise<NotificationConfig>
[src]

Gets a notification config.

@param name

Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]".

§
projectsNotificationConfigsList(parent: string, opts?: ProjectsNotificationConfigsListOptions): Promise<ListNotificationConfigsResponse>
[src]

Lists notification configs.

@param parent

Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

§
projectsNotificationConfigsPatch(name: string, req: NotificationConfig, opts?: ProjectsNotificationConfigsPatchOptions): Promise<NotificationConfig>
[src]

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

@param name

The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".

§
projectsSecurityHealthAnalyticsSettingsCustomModulesCreate(parent: string, req: GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.

@param parent

Required. Resource name of the new custom module's parent. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
projectsSecurityHealthAnalyticsSettingsCustomModulesDelete(name: string): Promise<Empty>
[src]

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

@param name

Required. Name of the custom module to delete. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
projectsSecurityHealthAnalyticsSettingsCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule>
[src]

Retrieves a SecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}"

§
projectsSecurityHealthAnalyticsSettingsCustomModulesList(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsCustomModulesListOptions): Promise<ListSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§
projectsSecurityHealthAnalyticsSettingsCustomModulesListDescendant(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsCustomModulesListDescendantOptions): Promise<ListDescendantSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.

@param parent

Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

@param name

Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

§
projectsSecurityHealthAnalyticsSettingsCustomModulesSimulate(parent: string, req: SimulateSecurityHealthAnalyticsCustomModuleRequest): Promise<SimulateSecurityHealthAnalyticsCustomModuleResponse>
[src]

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

@param parent

Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example: organizations/{organization_id}

§
projectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesGet(name: string): Promise<GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule>
[src]

Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.

@param name

Required. Name of the effective custom module to get. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"

§
projectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesList(parent: string, opts?: ProjectsSecurityHealthAnalyticsSettingsEffectiveCustomModulesListOptions): Promise<ListEffectiveSecurityHealthAnalyticsCustomModulesResponse>
[src]

Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.

@param parent

Required. Name of parent to list effective custom modules. Its format is "organizations/{organization}/securityHealthAnalyticsSettings", "folders/{folder}/securityHealthAnalyticsSettings", or "projects/{project}/securityHealthAnalyticsSettings"

§

Updates external system. This is for a given finding.

@param name

Full resource name of the external system, for example: "organizations/1234/sources/5678/findings/123456/externalSystems/jira", "folders/1234/sources/5678/findings/123456/externalSystems/jira", "projects/1234/sources/5678/findings/123456/externalSystems/jira"

§
projectsSourcesFindingsGroup(parent: string, req: GroupFindingsRequest): Promise<GroupFindingsResponse>
[src]

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

@param parent

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/-

§
projectsSourcesFindingsList(parent: string, opts?: ProjectsSourcesFindingsListOptions): Promise<ListFindingsResponse>
[src]

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

@param parent

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/-

§
projectsSourcesFindingsPatch(name: string, req: Finding, opts?: ProjectsSourcesFindingsPatchOptions): Promise<Finding>
[src]

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.

@param name

The relative resource name of the finding. 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}".

§
projectsSourcesFindingsSetMute(name: string, req: SetMuteRequest): Promise<Finding>
[src]

Updates the mute state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
projectsSourcesFindingsSetState(name: string, req: SetFindingStateRequest): Promise<Finding>
[src]

Updates the state of a finding.

@param name

Required. The relative resource name of the finding. 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}".

§
projectsSourcesFindingsUpdateSecurityMarks(name: string, req: SecurityMarks, opts?: ProjectsSourcesFindingsUpdateSecurityMarksOptions): Promise<SecurityMarks>
[src]

Updates security marks.

@param name

The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks".

§
projectsSourcesList(parent: string, opts?: ProjectsSourcesListOptions): Promise<ListSourcesResponse>
[src]

Lists all sources belonging to an organization.

@param parent

Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".