Interface Alert

interface Alert {
    alertId?: number;
    alertType?: AlertType;
    confidence?: Confidence;
    dismissal?: Dismissal;
    firstSeenDate?: Date;
    fixedDate?: Date;
    gitRef?: string;
    introducedDate?: Date;
    lastSeenDate?: Date;
    logicalLocations?: LogicalLocation[];
    physicalLocations?: PhysicalLocation[];
    repositoryUrl?: string;
    severity?: Severity;
    state?: State;
    title?: string;
    tools?: Tool[];
    truncatedSecret?: string;
    validationFingerprints?: ValidationFingerprint[];
}

Properties

alertId? alertType? confidence? dismissal? firstSeenDate? fixedDate? gitRef? introducedDate? lastSeenDate? logicalLocations? physicalLocations? repositoryUrl? severity? state? title? tools? truncatedSecret? validationFingerprints?

Properties

OptionalalertId

alertId?: number

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

OptionalalertType

alertType?: AlertType

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

Optionalconfidence

confidence?: Confidence

Confidence level of the alert.

Optionaldismissal

dismissal?: Dismissal

Contains information for the dismissal of the alert if the alert has been dismissed.

OptionalfirstSeenDate

firstSeenDate?: Date

This value is computed and returned by the service. This value represents the first time the service has seen this issue reported in an analysis instance.

OptionalfixedDate

fixedDate?: Date

This value is computed and returned by the service. If the issue is fixed, this value represents the time the service has seen this issue fixed in an analysis instance.

OptionalgitRef

gitRef?: string

Reference to a git object, e.g. branch ref.

OptionalintroducedDate

introducedDate?: Date

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

OptionallastSeenDate

lastSeenDate?: Date

This value is computed and returned by the service. This value represents the last time the service has seen this issue reported in an analysis instance.

OptionallogicalLocations

logicalLocations?: LogicalLocation[]

Logical locations for the alert. 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 logical location is a component.

OptionalphysicalLocations

physicalLocations?: PhysicalLocation[]

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.

OptionalrepositoryUrl

repositoryUrl?: string

Repository URL where the alert was detected.

Optionalseverity

severity?: Severity

Severity of the alert.

Optionalstate

state?: State

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

Optionaltitle

title?: string

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

Optionaltools

tools?: Tool[]

Tools that have detected this issue.

OptionaltruncatedSecret

truncatedSecret?: string

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

OptionalvalidationFingerprints

validationFingerprints?: ValidationFingerprint[]

ValidationFingerprints for the secret liveness check. Only returned on demand in Get API with Expand parameter set to be ValidationFingerprint (not returned in List API)

Settings

Member Visibility

On This Page

Properties