Alerts - List

Usługa:

Advanced Security

Wersja interfejsu API:

7.2-preview.1

Pobieranie alertów dla repozytorium

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts?api-version=7.2-preview.1

Z parametrami opcjonalnymi:

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts?top={top}&orderBy={orderBy}&criteria.alertIds={criteria.alertIds}&criteria.alertType={criteria.alertType}&criteria.confidenceLevels={criteria.confidenceLevels}&criteria.dependencyName={criteria.dependencyName}&criteria.fromDate={criteria.fromDate}&criteria.keywords={criteria.keywords}&criteria.licenseName={criteria.licenseName}&criteria.modifiedSince={criteria.modifiedSince}&criteria.onlyDefaultBranch={criteria.onlyDefaultBranch}&criteria.phaseId={criteria.phaseId}&criteria.phaseName={criteria.phaseName}&criteria.pipelineName={criteria.pipelineName}&criteria.ref={criteria.ref}&criteria.ruleId={criteria.ruleId}&criteria.ruleName={criteria.ruleName}&criteria.severities={criteria.severities}&criteria.states={criteria.states}&criteria.toDate={criteria.toDate}&criteria.toolName={criteria.toolName}&expand={expand}&continuationToken={continuationToken}&api-version=7.2-preview.1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
repository	path	True	string	Nazwa lub identyfikator repozytorium
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.2-preview.1", aby używać tej wersji interfejsu API.
continuationToken	query		string	Jeśli istnieje więcej alertów niż można zwrócić, token kontynuacji zostanie umieszczony w nagłówku "x-ms-continuationtoken". Użyj tego tokenu tutaj, aby uzyskać następną stronę alertów
criteria.alertIds	query		integer[]	Jeśli zostanie podana, zwracaj tylko alerty z określonymi identyfikatorami. W przeciwnym razie zwróć dowolny alert.
criteria.alertType	query		AlertType	W przypadku podania zwracane są tylko alerty tego typu. W przeciwnym razie zwróć alerty wszystkich typów.
criteria.confidenceLevels	query		string[]	W przypadku podania zwracane są tylko alerty na tych poziomach ufności. Aby pobrać alerty dotyczące wszystkich poziomów ufności, należy określić zarówno wysokie, jak i inne. W przeciwnym razie zwróć alerty o wysokim poziomie ufności. Dotyczy tylko alertów tajnych.
criteria.dependencyName	query		string	W przypadku podania zwracane są tylko alerty dotyczące tej zależności. W przeciwnym razie zwróć alerty dla wszystkich zależności. W przesłaniu sarif zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation. Nie dotyczy alertów tajnych.
criteria.fromDate	query		string date-time	W przypadku podania zwracaj tylko alerty ostatnio widoczne po tej dacie. W przeciwnym razie zwróć wszystkie alerty.
criteria.keywords	query		string	W przypadku podania zwracaj tylko alerty, których tytuły są zgodne z tym wzorcem.
criteria.licenseName	query		string	Jeśli zostanie podana, zwracane są tylko alerty utworzone dla zależności z tą licencją. W przeciwnym razie zwróć alerty dotyczące wszystkich licencji. W przesłaniu sarif licencja na zależność (lub składnik) jest określona w wyniku. RelatedLocations[].logicalLocation.properties.license. Nie dotyczy alertów tajnych.
criteria.modifiedSince	query		string date-time	Jeśli zostanie podana, zwracaj tylko alerty, które zostały zmodyfikowane od tej daty. W przeciwnym razie zwróć wszystkie alerty.
criteria.onlyDefaultBranch	query		boolean	Jeśli wartość true lub nie jest ustawiona, zwracane są tylko alerty znalezione w domyślnej gałęzi repozytorium. Jeśli w gałęzi domyślnej nie ukończono żadnych przebiegów, ostatni przebieg jest używany zamiast tego, niezależnie od gałęzi używanej do tego uruchomienia. Jeśli wartość false, zwróć alerty ze wszystkich gałęzi. Ta opcja jest ignorowana w przypadku podania odwołania. Nie dotyczy alertów tajnych.
criteria.phaseId	query		string uuid	W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku W przeciwnym razie zwróć alerty wykryte we wszystkich fazach. Nie dotyczy alertów tajnych.
criteria.phaseName	query		string	W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku W przeciwnym razie zwróć alerty wykryte we wszystkich fazach. Nie dotyczy alertów tajnych.
criteria.pipelineName	query		string	W przypadku podania zwracane są tylko alerty wykryte w tym potoku. W przeciwnym razie zwróć alerty wykryte we wszystkich potokach. Nie dotyczy alertów tajnych.
criteria.ref	query		string	Jeśli zostanie podana, uwzględnij tylko alerty dotyczące tego odwołania. Jeśli nie podano wartości i wartość OnlyDefaultBranch ma wartość true, uwzględnij tylko alerty znalezione w gałęzi domyślnej lub ostatniej gałęzi uruchamiania, jeśli nie ma konfiguracji analizy dla gałęzi domyślnej. W przeciwnym razie uwzględnij alerty ze wszystkich gałęzi. Nie dotyczy alertów tajnych.
criteria.ruleId	query		string	Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. W przeciwnym razie zwróć alerty dotyczące wszystkich reguł.
criteria.ruleName	query		string	Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. W przeciwnym razie zwróć alerty dla wszystkich reguł.
criteria.severities	query		string[]	Jeśli zostanie podana, zwracaj tylko alerty o tych ważnościach. W przeciwnym razie zwróć alerty o dowolnej ważności.
criteria.states	query		string[]	W przypadku podania zwracane są tylko alerty w tych stanach. W przeciwnym razie zwróć alerty w dowolnym stanie.
criteria.toDate	query		string date-time	Jeśli zostanie podana, zwróć tylko alerty ostatnio widoczne przed tą datą. W przeciwnym razie zwróć wszystkie alerty.
criteria.toolName	query		string	W przypadku podania parametru toolName zwracane są tylko alerty wykryte przez to narzędzie. W przeciwnym razie zwróć alerty wykryte przez wszystkie narzędzia.
expand	query		AlertListExpandOption
orderBy	query		string	Musi mieć wartość "id" "firstSeen" "lastSeen" "fixedOn" lub "ważność" Wartości domyślne do "id"
top	query		integer int32	Maksymalna liczba alertów do zwrócenia

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Alert[]	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.advsec	Przyznaje możliwość odczytywania alertów, wystąpień wyników, wystąpień wyników analizy

Definicje

Nazwa	Opis
Alert
AlertListExpandOption
AlertType	Typ alertu. Np. wpis tajny, kod itp.
Confidence	Poziom ufności alertu.
DependencyKind	Rodzaj zależności tej lokalizacji logicznej.
Dismissal	Informacje o odrzucaniu alertu
DismissalType	Przyczyna zwolnienia
IdentityRef
License	Informacje o licencji dla zależności
LicenseState	Stan licencji
LogicalLocation
PhysicalLocation	Lokalizacja w systemie kontroli źródła, w którym znaleziono problem
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
Region
RelationMetadata	Metadane, które mają być skojarzone z alertem.
Rule	Reguła analizy, która spowodowała alert.
Severity	Ważność alertu.
State	Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.
Tool	Narzędzie analizy, które może generować alerty zabezpieczeń
ValidationFingerprint
VersionControlDetails	Informacje dotyczące lokalizowania plików w systemie kontroli źródła

Alert

Nazwa	Typ	Opis
alertId	integer	Identyfikator alertu. Jest ona unikatowa w organizacji usługi Azure DevOps.
alertType	AlertType	Typ alertu. Np. wpis tajny, kod itp.
confidence	Confidence	Poziom ufności alertu.
dismissal	Dismissal	Zawiera informacje o odrzuceniu alertu, jeśli alert został odrzucony.
firstSeenDate	string	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.
fixedDate	string	Ta wartość jest obliczana i zwracana przez usługę. Jeśli problem został rozwiązany, ta wartość reprezentuje czas, w jaki usługa widziała ten problem rozwiązany w wystąpieniu analizy.
gitRef	string	Odwołanie do obiektu git, np. odwołania do gałęzi.
introducedDate	string	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy luka w zabezpieczeniach została wprowadzona.
lastSeenDate	string	Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje ostatni raz, gdy usługa widziała ten problem zgłoszony w wystąpieniu analizy.
logicalLocations	LogicalLocation[]	Lokalizacje logiczne alertu. Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji logicznej jest składnik.
physicalLocations	PhysicalLocation[]	Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy. Przykładem lokalizacji fizycznej jest lokalizacja pliku.
relations	RelationMetadata[]	Relacje między alertami i innymi artefaktami.
repositoryUrl	string	Adres URL repozytorium, pod którym wykryto alert.
severity	Severity	Ważność alertu.
state	State	Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.
title	string	Tytuł będzie renderowany tylko jako tekst i nie obsługuje formatowania markdown. Maksymalny limit znaków wynosi 256.
tools	Tool[]	Narzędzia, które wykryły ten problem.
truncatedSecret	string	Obcięta/zaciemniona wersja wpisu tajnego odnoszącego się do alertu (jeśli dotyczy).
validationFingerprints	ValidationFingerprint[]	ValidationFingerprints dla tajnego sprawdzania aktualności. Zwracane tylko na żądanie w obszarze Pobieranie interfejsu API z ustawionym parametrem Expand ma wartość ValidationFingerprint (nie jest zwracana w interfejsie API listy)

AlertListExpandOption

Nazwa	Typ	Opis
minimal	string	Zwraca minimalną reprezentację alertu.
none	string	Brak rozszerzeń.

AlertType

Typ alertu. Np. wpis tajny, kod itp.

Nazwa	Typ	Opis
code	string	Kod zawiera słabość określoną przez analizę statyczną.
dependency	string	Kod używa zależności ze znaną luką w zabezpieczeniach.
secret	string	Kod zawiera wpis tajny, który został teraz naruszony i musi zostać odwołany.
unknown	string	Kod ma nieokreślony typ luki w zabezpieczeniach

Confidence

Poziom ufności alertu.

Nazwa	Typ	Opis
high	string	Wysoki poziom ufności alertu
other	string	Inny poziom ufności alertu

DependencyKind

Rodzaj zależności tej lokalizacji logicznej.

Nazwa	Typ	Opis
component	string	Składnik, który jest powiadamiany.
rootDependency	string	Zależność główna wprowadziła składnik, który jest alertowany.
unknown	string
vulnerableDependency	string	Zależność podatna na zagrożenia. Oznaczanie tej wartości jako przestarzałej. Zamiast tego użyj składnika.

Dismissal

Informacje o odrzucaniu alertu

Nazwa	Typ	Opis
dismissalId	integer	Unikatowy identyfikator dla tego odrzucenia
dismissalType	DismissalType	Przyczyna zwolnienia
message	string	Komunikat informacyjny dołączony do odrzucenia
stateChangedBy	string	Tożsamość, która odrzuciła alert
stateChangedByIdentity	IdentityRef	Tożsamość, która odrzuciła alert

DismissalType

Przyczyna zwolnienia

Nazwa	Typ	Opis
acceptedRisk	string	Odrzucanie wskazujące, że użytkownik akceptuje ryzyko dla alertu
agreedToGuidance	string	Odrzucanie wskazujące, że użytkownik zgadza się przestrzegać wskazówek dotyczących licencji.
falsePositive	string	Odrzucanie wskazujące, że alert jest fałszywie dodatni i prawdopodobnie nie zostanie naprawiony.
fixed	string	Odrzucanie wskazujące, że alert został naprawiony
unknown	string	Nieznany typ odrzucania

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

License

Informacje o licencji dla zależności

Nazwa	Typ	Opis
name	string	Nazwa licencji
state	LicenseState	Stan licencji
url	string	Adres URL informacji o licencji

LicenseState

Stan licencji

Nazwa	Typ	Opis
harvested	string	Informacje o licencji zostały zebrane przez użytkownika ClearlyDefined
notHarvested	string	Informacje o licencji nie zostały zebrane przez użytkownika ClearlyDefined
unknown	string	Informacje o licencji nie zostały zebrane przez użytkownika ClearlyDefined

LogicalLocation

Nazwa	Typ	Opis
fullyQualifiedName	string
kind	DependencyKind	Rodzaj zależności tej lokalizacji logicznej.
license	License	Informacje o licencji dla zależności mają zastosowanie tylko wtedy, gdy rodzaj to "Składnik", a alertTyp alertu z tą lokalizacją to Licencja

PhysicalLocation

Lokalizacja w systemie kontroli źródła, w którym znaleziono problem

Nazwa	Typ	Opis
filePath	string	Ścieżka pliku, w którym znaleziono problem
region	Region	Szczegółowe informacje o lokalizacji, w której znaleziono problem, w tym fragmentu kodu
versionControl	VersionControlDetails	Informacje specyficzne dla systemu kontroli źródła dotyczące lokalizacji

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Region

Nazwa	Typ	Opis
columnEnd	integer	Kolumna, w której kończy się fragment kodu
columnStart	integer	Kolumna, w której rozpoczyna się fragment kodu
lineEnd	integer	Numer wiersza, w którym kończy się fragment kodu
lineStart	integer	Numer wiersza, w którym rozpoczyna się fragment kodu

RelationMetadata

Metadane, które mają być skojarzone z alertem.

Nazwa	Typ	Opis
attributes	object	Wszelkie dodatkowe atrybuty metadanych.
rel	string	Typ metadanych.
url	string	Adres URL metadanych.

Rule

Reguła analizy, która spowodowała alert.

Nazwa	Typ	Opis
additionalProperties	object	Dodatkowe właściwości tej reguły zależą od typu reguły. Na przykład reguły zależności mogą zawierać identyfikator CVE, jeśli jest dostępny.
description	string	Opis wykrywania tej reguły
friendlyName	string	Identyfikator reguły zwykłego tekstu
helpMessage	string	Dodatkowe informacje o tej regule
opaqueId	string	Identyfikator reguły specyficznej dla narzędzia
resources	string	Lista zasobów w formacie markdown, aby dowiedzieć się więcej o regule. W niektórych przypadkach zamiast tego jest używana reguła RuleInfo.AdditionalProperties.advisoryUrls.
tags	string[]	Tagi klasyfikacji dla tej reguły

Severity

Ważność alertu.

Nazwa	Typ	Opis
critical	string
error	string
high	string
low	string
medium	string
note	string
undefined	string
warning	string

State

Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.

Nazwa	Typ	Opis
active	string	Alert został wykryty w kodzie
autoDismissed	string	Narzędzie ustaliło, że problem nie jest już ryzykiem
dismissed	string	Alert został odrzucony przez użytkownika
fixed	string	Problem nie jest już wykrywany w kodzie
unknown	string	Alert jest w stanie nieokreślonym

Tool

Narzędzie analizy, które może generować alerty zabezpieczeń

Nazwa	Typ	Opis
name	string	Nazwa narzędzia
rules	Rule[]	Reguły definiowane przez narzędzie

ValidationFingerprint

Nazwa	Typ	Opis
validationFingerprintHash	string
validationFingerprintJson	string

VersionControlDetails

Informacje dotyczące lokalizowania plików w systemie kontroli źródła

Nazwa	Typ	Opis
commitHash	string
itemUrl	string