Edit

Share via


DashboardAlert interface

An alert entity used in the dashboard for combined alerts.

Properties

alertId

Identifier for the alert. It is unique within Azure DevOps organization.

alertType

Type of the alert. E.g. secret, code, etc.

introducedDate

This value is computed and returned by the service. This value represents the first time the vulnerability was introduced.

locations

This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a physical location is a file location.

projectName

Name of the project where the alert was detected.

repositoryName

Name of the repository where the alert was detected.

severity

Severity of the alert.

state

This value is computed and returned by the service. It is a value based on the results from all analysis configurations.

title

Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 256.

truncatedSecret

A truncated/obfuscated version of the secret pertaining to the alert (if applicable).

validityStatus

Validity status of an alert. Currently, this is only applicable to secret alerts. In case of secret alerts, the validity status is computed by looking at the liveness results for validation fingerprints associated to an alert.

Property Details

alertId

Identifier for the alert. It is unique within Azure DevOps organization.

alertId: number

Property Value

number

alertType

Type of the alert. E.g. secret, code, etc.

alertType: AlertType

Property Value

introducedDate

This value is computed and returned by the service. This value represents the first time the vulnerability was introduced.

introducedDate: Date

Property Value

Date

locations

This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a physical location is a file location.

locations: DashboardAlertPhysicalLocation[]

Property Value

projectName

Name of the project where the alert was detected.

projectName: string

Property Value

string

repositoryName

Name of the repository where the alert was detected.

repositoryName: string

Property Value

string

severity

Severity of the alert.

severity: Severity

Property Value

state

This value is computed and returned by the service. It is a value based on the results from all analysis configurations.

state: State

Property Value

title

Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 256.

title: string

Property Value

string

truncatedSecret

A truncated/obfuscated version of the secret pertaining to the alert (if applicable).

truncatedSecret: string

Property Value

string

validityStatus

Validity status of an alert. Currently, this is only applicable to secret alerts. In case of secret alerts, the validity status is computed by looking at the liveness results for validation fingerprints associated to an alert.

validityStatus: AlertValidityStatus

Property Value