Security Deck Alerts API, gRPC: AlertService.Update

Field

Description

alert_id

string

Required field. Alert ID to update.

The maximum string length in characters is 50.

update_mask

google.protobuf.FieldMask

Required field. Field mask that specifies which fields of the alert to update.

status

enum Status

Alert status.
Optional. Not used if not present in update_mask.

• OPEN: Status is "open". Alert is not being currently processed.
• IN_PROGRESS: Status is "in progress". Alert assignee is currently processing the alert.
• NEED_INFO: Status is "need info". Alert assignee cannot currently process the alert and requires additional information.
• RESOLVED: Status is "resolved". Alert processing has concluded.

classification

enum Classification

Alert classification.
Optional. Can be omitted but present in update_mask to remove classification. Not used if not present in update_mask.

• TRUE_POSITIVE: Alert represents an actual problem that needs to be mitigated.
• BENIGN_POSITIVE: Alert represents a legitimate problem but does not require attention.
• FALSE_POSITIVE: Alert represents something that's not an issue.
• UNDETERMINED: Alert relevance cannot be determined.

assignee_subject_id

string

Assign alert to a subject with specified ID.
Subject must be a USER_ACCOUNT resolvable by method caller.
Optional. Can be omitted but present in update_mask to remove assignee. Not used if not present in update_mask.

Includes only one of the fields assignee_subject_id.

Alert assignee.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.