REST Resource: organizations.notificationConfigs

Resource: NotificationConfig

Security Command Center notification configs.

A notification config is a Security Command Center resource that contains the configuration to send notifications for create/update events of findings, assets and etc.

JSON representation
{
  "name": string,
  "description": string,
  "eventType": enum (EventType),
  "pubsubTopic": string,
  "serviceAccount": string,
  "streamingConfig": {
    object (StreamingConfig)
  }
}
Fields
name

string

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".

description

string

The description of the notification config (max of 1024 characters).

eventType

enum (EventType)

The type of events the config is for, e.g. FINDING.

pubsubTopic

string

The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".

serviceAccount

string

Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.

streamingConfig

object (StreamingConfig)

The config for triggering streaming-based notifications.

EventType

The type of events.

Enums
EVENT_TYPE_UNSPECIFIED Unspecified event type.
FINDING Events for findings.

StreamingConfig

The config for streaming-based notifications, which send each event as soon as it is detected.

JSON representation
{
  "filter": string
}
Fields
filter

string

Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

Methods

create

Creates a notification config.

delete

Deletes a notification config.

get

Gets a notification config.

list

Lists notification configs.

patch

Updates a notification config.