Freigeben über

Alerts - Get

Dienst:
Advanced Security
API-Version:
7.2-preview.1

Erhalten Sie eine Benachrichtigung.

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}?api-version=7.2-preview.1
Mit optionalen Parametern: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}?ref={ref}&expand={expand}&api-version=7.2-preview.1

URI-Parameter

Name In Erforderlich Typ Beschreibung
alertId
 path True

integer (int64)

ID der abzurufenden Warnung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
project
 path True

string

Projekt-ID oder Projektname
repository
 path True

string

Name oder ID eines Repositorys, in dem eine Warnung enthalten ist
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "7.2-preview.1" festgelegt werden, um diese Version der API zu verwenden.
expand
 query

ExpandOption

Erweitern Sie Attribute einer geheimen Warnung. Mögliche Werte sind None und ValidationFingerprint. Wird standardmäßig auf None festgelegt. Beachten Sie, dass die Antwort bei expand Festlegung auf ValidationFingerprintdas Geheimnis in unverschlüsselter Form enthalten kann. Seien Sie vorsichtig, wenn Sie diese Daten verwenden.
ref
 query

string

Antworten

Name Typ Beschreibung
200 OK

Alert

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Bereiche

Name Beschreibung
vso.advsec Gewährt die Möglichkeit, Warnungen, Ergebnisinstanzen, Analyseergebnisinstanzen zu lesen

Definitionen

Name Beschreibung
Alert
AlertType

Typ der Warnung. Z.B. geheimer Schlüssel, Code usw.
AlertValidityInfo

Gültigkeitsdaten für eine Warnung, die Teil von Warnungs-APIs und UI sind.
AlertValidityStatus
Confidence

Konfidenzniveau der Warnung.
DependencyKind

Abhängigkeitsart dieses logischen Speicherorts.
Dismissal

Informationen über eine Warnungskündigung
DismissalType

Grund für die Kündigung
ExpandOption

Erweitern Sie Attribute einer geheimen Warnung. Mögliche Werte sind None und ValidationFingerprint. Wird standardmäßig auf None festgelegt. Beachten Sie, dass die Antwort bei expand Festlegung auf ValidationFingerprintdas Geheimnis in unverschlüsselter Form enthalten kann. Seien Sie vorsichtig, wenn Sie diese Daten verwenden.
IdentityRef
License

Lizenzinformationen für Abhängigkeiten
LicenseState

Lizenzstatus
LicenseType

Lizenztyp
LogicalLocation
PhysicalLocation

Speicherort im Quellcodeverwaltungssystem, an dem das Problem gefunden wurde
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
Region
RelationMetadata

Die Metadaten, die der Warnung zugeordnet werden sollen.
Rule

Die Analyseregel, die die Warnung verursacht hat.
Severity

Schweregrad der Warnung.
State

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Es handelt sich um einen Wert, der auf den Ergebnissen aller Analysekonfigurationen basiert.
Tool

Ein Analysetool, mit dem Sicherheitswarnungen generiert werden können
ValidationFingerprint
ValidationResult

Das Ergebnis der Überprüfung.
VersionControlDetails

Informationen zum Suchen von Dateien in einem Quellcodeverwaltungssystem

Alert

Objekt
Name Typ Beschreibung
additionalProperties

object

Zusätzliche Eigenschaften dieser Warnung.
alertId

integer (int64)

Bezeichner für die Warnung. Sie ist innerhalb der Azure DevOps-Organisation einzigartig.
alertType

AlertType

Typ der Warnung. Z.B. geheimer Schlüssel, Code usw.
confidence

Confidence

Konfidenzniveau der Warnung.
dismissal

Dismissal

Enthält Informationen zur Kündigung der Warnung, wenn die Warnung geschlossen wurde.
firstSeenDate

string (date-time)

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Dieser Wert stellt das erste Mal dar, wenn der Dienst dieses Problem in einer Analyseinstanz gemeldet hat.
fixedDate

string (date-time)

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Wenn das Problem behoben ist, stellt dieser Wert den Zeitpunkt dar, zu dem dieses Problem in einer Analyseinstanz behoben wurde.
gitRef

string

Verweis auf ein Git-Objekt, z. B. Verzweigungsreferenz.
hasTrustedSourceOrigin

boolean

Value gibt an, ob die Warnung von einem SARIF stammt, der von einer vertrauenswürdigen Quelle hochgeladen wurde.
introducedDate

string (date-time)

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Dieser Wert stellt das erste Mal dar, wenn die Sicherheitsanfälligkeit eingeführt wurde.
lastSeenDate

string (date-time)

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Dieser Wert stellt das letzte Mal dar, wenn der Dienst dieses Problem in einer Analyseinstanz gemeldet hat.
logicalLocations

LogicalLocation[]

Logische Speicherorte für die Warnung. Dieser Wert wird berechnet und vom Dienst zurückgegeben. Es handelt sich um einen Wert, der auf den Ergebnissen aller Analysekonfigurationen basiert. Ein Beispiel für eine logische Position ist eine Komponente.
physicalLocations

PhysicalLocation[]

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Es handelt sich um einen Wert, der auf den Ergebnissen aller Analysekonfigurationen basiert. Ein Beispiel für einen physischen Speicherort ist ein Dateispeicherort.
projectId

string (uuid)

Bezeichner des Projekts, in dem die Warnung erkannt wurde.
relations

RelationMetadata[]

Beziehungen zwischen Warnungen und anderen Artefakten.
repositoryId

string

Bezeichner des Repositorys, in dem die Warnung erkannt wurde.
repositoryUrl

string

Repository-URL, in der die Warnung erkannt wurde.
severity

Severity

Schweregrad der Warnung.
state

State

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Es handelt sich um einen Wert, der auf den Ergebnissen aller Analysekonfigurationen basiert.
title

string

Der Titel wird nur als Text gerendert und unterstützt keine Markdownformatierung. Es gibt eine maximale Zeichengrenze von 256.
tools

Tool[]

Tools, die dieses Problem erkannt haben.
truncatedSecret

string

Eine abgeschnittene/verschleierte Version des geheimen Schlüssels, die sich auf die Warnung bezieht (falls zutreffend).
validationFingerprints

ValidationFingerprint[]

ValidationFingerprints für die geheime Liveness-Prüfung. Wird nur bei Bedarf in get API zurückgegeben, wobei der Parameter "Expand" auf "ValidationFingerprint" festgelegt ist (nicht in der Listen-API zurückgegeben)
validityDetails

AlertValidityInfo

Gültigkeitsdetails einer Warnung. Derzeit gilt dies nur für geheime Warnungen. Bei geheimen Warnungen wird der Gültigkeitsstatus und die Uhrzeit berechnet, indem die Livenessergebnisse für Validierungsabdrücke betrachtet werden, die einer Warnung zugeordnet sind.

AlertType

Enumeration

Typ der Warnung. Z.B. geheimer Schlüssel, Code usw.

Wert Beschreibung
unknown

Der Code weist einen nicht angegebenen Sicherheitsrisikotyp auf.
dependency

Der Code verwendet eine Abhängigkeit mit einer bekannten Sicherheitsanfälligkeit.
secret

Der Code enthält einen geheimen Schlüssel, der jetzt kompromittiert wurde und widerrufen werden muss.
code

Der Code enthält eine Schwäche, die durch statische Analysen bestimmt wird.

AlertValidityInfo

Objekt

Gültigkeitsdaten für eine Warnung, die Teil von Warnungs-APIs und UI sind.

Name Typ Beschreibung
validityLastCheckedDate

string (date-time)

validityStatus

AlertValidityStatus

AlertValidityStatus

Enumeration
Wert Beschreibung
none

Wenn keine Überprüfungsabdrücke an die Warnung angefügt sind.
unknown

Wenn die Überprüfungen für Überprüfungsabdrücke, die der Warnung zugeordnet sind, nicht eindeutig waren.
active

Wenn mindestens ein Überprüfungsabdruck, der der Warnung zugeordnet ist, ausnutzbar ist.
inactive

Wenn alle der Warnung zugeordneten Überprüfungsabdrücke nicht ausnutzbar sind.

Confidence

Enumeration

Konfidenzniveau der Warnung.

Wert Beschreibung
high

Hohes Konfidenzniveau für Warnungen
other

Andere Konfidenzstufe für Warnungen

DependencyKind

Enumeration

Abhängigkeitsart dieses logischen Speicherorts.

Wert Beschreibung
unknown
rootDependency

Die Stammabhängigkeit hat die Komponente eingeführt, die benachrichtigt wird.
component

Die Komponente, die benachrichtigt wird.
vulnerableDependency

Anfällige Abhängigkeit. Dieser Wert wird nicht mehr unterstützt. Verwenden Sie stattdessen Component.

Dismissal

Objekt

Informationen über eine Warnungskündigung

Name Typ Beschreibung
dismissalId

integer (int64)

Eindeutige ID für diese Kündigung
dismissalType

DismissalType

Grund für die Kündigung
message

string

Informationsnachricht, die an die Entlassung angefügt ist
stateChangedBy

string (uuid)

Identität, die die Warnung geschlossen hat
stateChangedByIdentity

IdentityRef

Identität, die die Warnung geschlossen hat

DismissalType

Enumeration

Grund für die Kündigung

Wert Beschreibung
unknown

Unbekannter Einstellungstyp
fixed

Entlassung, die angibt, dass die Warnung behoben wurde
acceptedRisk

Kündigung, die angibt, dass der Benutzer ein Risiko für die Warnung akzeptiert
falsePositive

Entlassung, die darauf hinweist, dass die Warnung falsch positiv ist und wahrscheinlich nicht behoben wird.
agreedToGuidance

Kündigung, die angibt, dass der Benutzer der Lizenzanleitung zustimmt.
toolUpgrade

Kündigung, die angibt, dass das Back-End-Erkennungstool aktualisiert wurde und die Warnung nicht von der neuen Version des Tools erkannt wird.
notDistributed

Entlassung, die angibt, dass die betroffene Abhängigkeitsfähigkeit nicht an Endbenutzer verteilt wird.

ExpandOption

Enumeration

Erweitern Sie Attribute einer geheimen Warnung. Mögliche Werte sind None und ValidationFingerprint. Wird standardmäßig auf None festgelegt. Beachten Sie, dass die Antwort bei expand Festlegung auf ValidationFingerprintdas Geheimnis in unverschlüsselter Form enthalten kann. Seien Sie vorsichtig, wenn Sie diese Daten verwenden.

Wert Beschreibung
none

Keine Erweiterungen.
validationFingerprint

Zurückgeben von validationFingerprints in Alert.

IdentityRef

Objekt
Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias

string

Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id

string

imageUrl

string

Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive

boolean

Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity

boolean

Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName

string

Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

License

Objekt

Lizenzinformationen für Abhängigkeiten

Name Typ Beschreibung
name

string

Lizenzname
state

LicenseState

Lizenzstatus
type

LicenseType

Lizenztyp
url

string

URL für Lizenzinformationen

LicenseState

Enumeration

Lizenzstatus

Wert Beschreibung
unknown

Informationen zur Lizenz wurden von ClearlyDefined nicht gesammelt.
notHarvested

Informationen zur Lizenz wurden von ClearlyDefined nicht gesammelt.
harvested

Informationen zur Lizenz wurden von ClearlyDefined gesammelt.

LicenseType

Enumeration

Lizenztyp

Wert Beschreibung
unknown

Der Lizenztyp ist unbekannt oder nicht angegeben.
permissive

Eine zulässige Lizenz ermöglicht es Software, frei verwendet, geändert und mit minimalen Einschränkungen verteilt zu werden. Beispiele: MIT, Apache 2.0.
weakCopyleft

Eine schwache Copyleft-Lizenz erfordert Änderungen an der Software, die unter derselben Lizenz freigegeben werden sollen, aber keine Einschränkungen für größere Werke, die die Software enthalten. Beispiele: LGPL.
strongCopyleft

Eine starke Copyleft-Lizenz erfordert, dass alle abgeleiteten Werke oder größeren Werke, die die Software enthalten, ebenfalls unter derselben Lizenz verteilt werden müssen. Beispiele: GPL.
networkCopyleft

Eine Lizenz für Netzwerkkopieleft erweitert die Copyleft-Anforderung auf Software, auf die über ein Netzwerk zugegriffen wird, sodass der Quellcode verfügbar gemacht werden muss. Beispiele: AGPL.
other

Eine Lizenz, die nicht in die Standardkategorien passt oder benutzerdefiniert ist. In CG gibt sie eine kommerzielle Lizenz an.
noAssertion

Es wird keine Behauptung über den Lizenztyp gemacht, sodass sie nicht angegeben wird.

LogicalLocation

Objekt
Name Typ Beschreibung
fullyQualifiedName

string

kind

DependencyKind

Abhängigkeitsart dieses logischen Speicherorts.
license

License

Lizenzinformationen für Abhängigkeit nur anwendbar, wenn Art "Component" ist und der AlertType der Warnung mit diesem Speicherort "License" ist

PhysicalLocation

Objekt

Speicherort im Quellcodeverwaltungssystem, an dem das Problem gefunden wurde

Name Typ Beschreibung
additionalProperties

object

Zusätzliche Eigenschaften für den Ort, an dem das Problem gefunden wurde
filePath

string

Pfad der Datei, in der das Problem gefunden wurde
isValidGitPath

boolean

Gibt an, ob der Pfad ein gültiger Git-Pfad ist, der im Git-Repository vorhanden ist, das der Warnung zugeordnet ist.
region

Region

Details zum Speicherort, an dem das Problem gefunden wurde, einschließlich eines Codeausschnitts
versionControl

VersionControlDetails

Systemspezifische Informationen zur Quellcodeverwaltung über den Speicherort
Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Region

Objekt
Name Typ Beschreibung
columnEnd

integer (int32)

Die Spalte, in der der Codeausschnitt endet
columnStart

integer (int32)

Die Spalte, in der der Codeausschnitt gestartet wird
lineEnd

integer (int32)

Die Zeilennummer, in der der Codeausschnitt endet
lineStart

integer (int32)

Die Zeilennummer, an der der Codeausschnitt beginnt

RelationMetadata

Objekt

Die Metadaten, die der Warnung zugeordnet werden sollen.

Name Typ Beschreibung
attributes

object

Alle zusätzlichen Attribute der Metadaten.
properties

object

Die Eigenschaften der Metadaten.
rel

string

Der Typ der Metadaten.
url

string

Die URL der Metadaten.

Rule

Objekt

Die Analyseregel, die die Warnung verursacht hat.

Name Typ Beschreibung
additionalProperties

object

Zusätzliche Eigenschaften dieser Regel, die vom Regeltyp abhängig sind. Abhängigkeitsregeln können z. B. die CVE-ID enthalten, wenn sie verfügbar ist.
description

string

Beschreibung der Erkennung dieser Regel
friendlyName

string

Nur-Text-Regelbezeichner
helpMessage

string

Weitere Informationen zu dieser Regel
opaqueId

string

Toolspezifischer Regelbezeichner
resources

string

Markdown-formatierte Liste der Ressourcen, um mehr über die Regel zu erfahren. In einigen Fällen wird stattdessen RuleInfo.AdditionalProperties.advisoryUrls verwendet.
tags

string[]

Klassifizierungstags für diese Regel

Severity

Enumeration

Schweregrad der Warnung.

Wert Beschreibung
low
medium
high
critical
note
warning
error
undefined

State

Enumeration

Dieser Wert wird berechnet und vom Dienst zurückgegeben. Es handelt sich um einen Wert, der auf den Ergebnissen aller Analysekonfigurationen basiert.

Wert Beschreibung
unknown

Warnung befindet sich in einem unbestimmten Zustand
active

Warnung wurde im Code erkannt
dismissed

Warnung wurde von einem Benutzer geschlossen.
fixed

Das Problem wird im Code nicht mehr erkannt.
autoDismissed

Das Tool hat festgestellt, dass das Problem kein Risiko mehr ist.

Tool

Objekt

Ein Analysetool, mit dem Sicherheitswarnungen generiert werden können

Name Typ Beschreibung
name

string

Name des Tools
rules

Rule[]

Die Regeln, die das Tool definiert

ValidationFingerprint

Objekt
Name Typ Beschreibung
assetFingerprint

object

Die Schlüsselwertdarstellung des Asset-Fingerabdrucks.
c3Id

string

Represents the CrossCompanyCorrelatingId for the secret in the ValidationFingerprintJson.
validationFingerprintHash

string

Der Hash, der dem geheimen Schlüssel zugeordnet ist.
validationFingerprintJson

string

Die JSON-Darstellung des geheimen Schlüssels. Beachten Sie, dass dieses Feld das Geheimnis in seiner unverschlüsselten Form enthalten kann. Achten Sie bei der Verwendung dieses Felds auf Vorsicht.
validityLastUpdatedDate

string (date-time)

Das Datum, an dem die Gültigkeit zuletzt aktualisiert wurde.
validityResult

ValidationResult

Das Ergebnis der Überprüfung.

ValidationResult

Enumeration

Das Ergebnis der Überprüfung.

Wert Beschreibung
none

Standardwert: Es können keine Informationen über den geheimen Schlüssel daraus abgeleitet werden.
exploitable

Stellt einen geheimen Schlüssel dar, der zum Herstellen einer Verbindung mit einer Ressource verwendet werden kann.
notExploitable

Stellt einen geheimen Schlüssel dar, der nicht zum Herstellen einer Verbindung mit einer Ressource verwendet werden kann.
inconclusive

Stellt ein Geheimnis dar, in dem keine Bestimmung über seine Ausnutzbarkeit getroffen werden kann.
validationNotSupported

Stellt einen geheimen Schlüssel dar, bei dem wir nicht überprüfen können, z. B. fehlender dynamischer Validator.
transientError

Stellt einen geheimen Schlüssel dar, bei dem der Überprüfungsprozess aufgrund eines vorübergehenden Fehlers fehlgeschlagen ist, z. B. Netzwerkproblem. Dieses Ergebnis gibt an, dass der Überprüfungsprozess erneut ausgeführt werden soll.

VersionControlDetails

Objekt

Informationen zum Suchen von Dateien in einem Quellcodeverwaltungssystem

Name Typ Beschreibung
commitHash

string

itemUrl

string