Alerts - List
Pobieranie alertów dla repozytorium
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts?api-version=7.2-preview.1
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.hasLinkedWorkItems={criteria.hasLinkedWorkItems}&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}&criteria.validity={criteria.validity}&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. |
|
continuation
|
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.
|
query |
integer[] |
Jeśli zostanie podana, zwracaj tylko alerty z określonymi identyfikatorami. |
|
|
criteria.
|
query |
W przypadku podania zwracane są tylko alerty tego typu. W przeciwnym razie zwróć alerty wszystkich typów. |
||
|
criteria.
|
query |
string[] |
W przypadku podania zwracane są tylko alerty na tych poziomach ufności. |
|
|
criteria.
|
query |
string |
W przypadku podania zwracane są tylko alerty dotyczące tej zależności. |
|
|
criteria.
|
query |
string (date-time) |
W przypadku podania zwracaj tylko alerty ostatnio widoczne po tej dacie. |
|
|
criteria.
|
query |
boolean |
Jeśli zostanie podana, filtruje alerty na podstawie tego, czy mają połączone elementy robocze. |
|
|
criteria.
|
query |
string |
W przypadku podania zwracaj tylko alerty, których tytuły są zgodne z tym wzorcem. |
|
|
criteria.
|
query |
string |
Jeśli zostanie podana, zwracane są tylko alerty utworzone dla zależności z tą licencją. |
|
|
criteria.
|
query |
string (date-time) |
Jeśli zostanie podana, zwracaj tylko alerty, które zostały zmodyfikowane od tej daty. |
|
|
criteria.
|
query |
boolean |
Jeśli wartość true lub nie jest ustawiona, zwracane są tylko alerty znalezione w domyślnej gałęzi repozytorium. |
|
|
criteria.
|
query |
string (uuid) |
W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku |
|
|
criteria.
|
query |
string |
W przypadku podania parametru pipelineName zwracane są tylko alerty wykryte w tej fazie potoku |
|
|
criteria.
|
query |
string |
W przypadku podania zwracane są tylko alerty wykryte w tym potoku. |
|
|
criteria.
|
query |
string |
Jeśli zostanie podana, uwzględnij tylko alerty dotyczące tego odwołania. |
|
|
criteria.
|
query |
string |
Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. |
|
|
criteria.
|
query |
string |
Jeśli zostanie podana, zwracaj tylko alerty dla tej reguły. |
|
|
criteria.
|
query |
string[] |
Jeśli zostanie podana, zwracaj tylko alerty o tych ważnościach. |
|
|
criteria.
|
query |
string[] |
W przypadku podania zwracane są tylko alerty w tych stanach. |
|
|
criteria.
|
query |
string (date-time) |
Jeśli zostanie podana, zwróć tylko alerty ostatnio widoczne przed tą datą. |
|
|
criteria.
|
query |
string |
W przypadku podania parametru toolName zwracane są tylko alerty wykryte przez to narzędzie. |
|
|
criteria.
|
query |
string[] |
Jeśli zostanie podana, zwracaj tylko alerty z ważnością określoną tutaj. Jeśli stan ważności to Nieznany, pobierz alerty wszystkich wyników ważności. |
|
|
expand
|
query | |||
|
order
|
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 | |
|
Alert |
|
|
Alert |
Typ alertu. Np. wpis tajny, kod itp. |
|
Alert |
Dane ważności alertu, który będzie częścią interfejsów API alertów i interfejsu użytkownika. |
|
Alert |
|
| Confidence |
Poziom ufności alertu. |
|
Dependency |
Rodzaj zależności tej lokalizacji logicznej. |
| Dismissal |
Informacje o odrzucaniu alertu |
|
Dismissal |
Przyczyna zwolnienia |
|
Identity |
|
| License |
Informacje o licencji dla zależności |
|
License |
Stan licencji |
|
License |
Typ licencji |
|
Logical |
|
|
Physical |
Lokalizacja w systemie kontroli źródła, w którym znaleziono problem |
|
Reference |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
| Region | |
|
Relation |
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ń |
|
Validation |
|
|
Validation |
Wynik weryfikacji. |
|
Version |
Informacje dotyczące lokalizowania plików w systemie kontroli źródła |
Alert
| Nazwa | Typ | Opis |
|---|---|---|
| additionalProperties |
object |
Dodatkowe właściwości tego alertu. |
| alertId |
integer (int64) |
Identyfikator alertu. Jest ona unikatowa w organizacji usługi Azure DevOps. |
| alertType |
Typ alertu. Np. wpis tajny, kod itp. |
|
| confidence |
Poziom ufności alertu. |
|
| dismissal |
Zawiera informacje o odrzuceniu alertu, jeśli alert został odrzucony. |
|
| firstSeenDate |
string (date-time) |
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 (date-time) |
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 (date-time) |
Ta wartość jest obliczana i zwracana przez usługę. Ta wartość reprezentuje pierwszy raz, gdy luka w zabezpieczeniach została wprowadzona. |
| lastSeenDate |
string (date-time) |
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 |
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 |
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. |
|
| projectId |
string (uuid) |
Identyfikator projektu, w którym wykryto alert. |
| relations |
Relacje między alertami i innymi artefaktami. |
|
| repositoryId |
string |
Identyfikator repozytorium, w którym wykryto alert. |
| repositoryUrl |
string |
Adres URL repozytorium, pod którym wykryto 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. |
|
| 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 |
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) |
|
| validityDetails |
Szczegóły ważności alertu. Obecnie dotyczy to tylko alertów tajnych. W przypadku alertów wpisów tajnych stan ważności i czas są obliczane przez sprawdzenie wyników aktualności dla odcisków palców weryfikacji skojarzonych z alertem. |
AlertListExpandOption
| Wartość | Opis |
|---|---|
| none |
Brak rozszerzeń. |
| minimal |
Zwraca minimalną reprezentację alertu. |
AlertType
Typ alertu. Np. wpis tajny, kod itp.
| Wartość | Opis |
|---|---|
| unknown |
Kod ma nieokreślony typ luki w zabezpieczeniach |
| dependency |
Kod używa zależności ze znaną luką w zabezpieczeniach. |
| secret |
Kod zawiera wpis tajny, który został teraz naruszony i musi zostać odwołany. |
| code |
Kod zawiera słabość określoną przez analizę statyczną. |
AlertValidityInfo
Dane ważności alertu, który będzie częścią interfejsów API alertów i interfejsu użytkownika.
| Nazwa | Typ | Opis |
|---|---|---|
| validityLastCheckedDate |
string (date-time) |
|
| validityStatus |
AlertValidityStatus
| Wartość | Opis |
|---|---|
| none |
Jeśli nie ma żadnych odcisków palców weryfikacji dołączonych do alertu. |
| unknown |
Gdy walidacje odcisków palców weryfikacji skojarzonych z alertem nie były jednoznaczne. |
| active |
Jeśli można wykorzystać co najmniej jeden odcisk palca weryfikacji skojarzony z alertem. |
| inactive |
Gdy wszystkie odciski palców weryfikacji skojarzone z alertem nie są możliwe do wykorzystania. |
Confidence
Poziom ufności alertu.
| Wartość | Opis |
|---|---|
| high |
Wysoki poziom ufności alertu |
| other |
Inny poziom ufności alertu |
DependencyKind
Rodzaj zależności tej lokalizacji logicznej.
| Wartość | Opis |
|---|---|
| unknown | |
| rootDependency |
Zależność główna wprowadziła składnik, który jest alertowany. |
| component |
Składnik, który jest powiadamiany. |
| vulnerableDependency |
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 (int64) |
Unikatowy identyfikator dla tego odrzucenia |
| dismissalType |
Przyczyna zwolnienia |
|
| message |
string |
Komunikat informacyjny dołączony do odrzucenia |
| stateChangedBy |
string (uuid) |
Tożsamość, która odrzuciła alert |
| stateChangedByIdentity |
Tożsamość, która odrzuciła alert |
DismissalType
Przyczyna zwolnienia
| Wartość | Opis |
|---|---|
| unknown |
Nieznany typ odrzucania |
| fixed |
Odrzucanie wskazujące, że alert został naprawiony |
| acceptedRisk |
Odrzucanie wskazujące, że użytkownik akceptuje ryzyko dla alertu |
| falsePositive |
Odrzucanie wskazujące, że alert jest fałszywie dodatni i prawdopodobnie nie zostanie naprawiony. |
| agreedToGuidance |
Odrzucanie wskazujące, że użytkownik zgadza się przestrzegać wskazówek dotyczących licencji. |
| toolUpgrade |
Odrzucanie wskazujące, że narzędzie wykrywania zaplecza zostało uaktualnione, a alert nie jest wykrywany przez nową wersję narzędzia. |
| notDistributed |
Odrzucanie wskazujące, że zależność, której dotyczy problem, nie jest dystrybuowana do użytkowników końcowych. |
IdentityRef
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
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 |
Stan licencji |
|
| type |
Typ licencji |
|
| url |
string |
Adres URL informacji o licencji |
LicenseState
Stan licencji
| Wartość | Opis |
|---|---|
| unknown |
Informacje o licencji nie zostały zebrane przez użytkownika ClearlyDefined |
| notHarvested |
Informacje o licencji nie zostały zebrane przez użytkownika ClearlyDefined |
| harvested |
Informacje o licencji zostały zebrane przez użytkownika ClearlyDefined |
LicenseType
Typ licencji
| Wartość | Opis |
|---|---|
| unknown |
Typ licencji jest nieznany lub nie został określony. |
| permissive |
Licencja permissywna pozwala na swobodne używanie, modyfikowanie i rozpowszechnianie oprogramowania z minimalnymi ograniczeniami. Przykłady: MIT, Apache 2.0. |
| weakCopyleft |
Słaba licencja copyleft wymaga modyfikacji oprogramowania, które mają być udostępniane w ramach tej samej licencji, ale nie nakłada ograniczeń na większe prace, które obejmują oprogramowanie. Przykłady: LGPL. |
| strongCopyleft |
Silna licencja copyleft wymaga, aby wszelkie prace pochodne lub większe, które obejmują oprogramowanie, również muszą być dystrybuowane na podstawie tej samej licencji. Przykłady: GPL. |
| networkCopyleft |
Licencja sieci copyleft rozszerza wymaganie copyleft oprogramowania, które jest dostępne za pośrednictwem sieci, co wymaga udostępnienia kodu źródłowego. Przykłady: AGPL. |
| other |
Licencja, która nie pasuje do standardowych kategorii lub jest zdefiniowana niestandardowie. W CG wskazuje licencję komercyjną. |
| noAssertion |
Nie ma potwierdzenia o typie licencji, pozostawiając go nieokreślony. |
LogicalLocation
| Nazwa | Typ | Opis |
|---|---|---|
| fullyQualifiedName |
string |
|
| kind |
Rodzaj zależności tej lokalizacji logicznej. |
|
| 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 |
Szczegółowe informacje o lokalizacji, w której znaleziono problem, w tym fragmentu kodu |
|
| versionControl |
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 (int32) |
Kolumna, w której kończy się fragment kodu |
| columnStart |
integer (int32) |
Kolumna, w której rozpoczyna się fragment kodu |
| lineEnd |
integer (int32) |
Numer wiersza, w którym kończy się fragment kodu |
| lineStart |
integer (int32) |
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.
| Wartość | Opis |
|---|---|
| low | |
| medium | |
| high | |
| critical | |
| note | |
| warning | |
| error | |
| undefined |
State
Ta wartość jest obliczana i zwracana przez usługę. Jest to wartość oparta na wynikach ze wszystkich konfiguracji analizy.
| Wartość | Opis |
|---|---|
| unknown |
Alert jest w stanie nieokreślonym |
| active |
Alert został wykryty w kodzie |
| dismissed |
Alert został odrzucony przez użytkownika |
| fixed |
Problem nie jest już wykrywany w kodzie |
| autoDismissed |
Narzędzie ustaliło, że problem nie jest już ryzykiem |
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 |
|---|---|---|
| assetFingerprint |
object |
Wartość klucza reprezentująca odcisk palca elementu zawartości. |
| validationFingerprintHash |
string |
Skrót skojarzony z wpisem tajnym. |
| validationFingerprintJson |
string |
Reprezentacja w formacie JSON wpisu tajnego. Należy pamiętać, że to pole może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tego pola należy zachować ostrożność. |
| validityLastUpdatedDate |
string (date-time) |
Data ostatniej aktualizacji ważności. |
| validityResult |
Wynik weryfikacji. |
ValidationResult
Wynik weryfikacji.
| Wartość | Opis |
|---|---|
| none |
Wartość domyślna— nie można wywnioskować żadnych informacji o wpisie tajnym. |
| exploitable |
Reprezentuje wpis tajny, który może służyć do nawiązywania połączenia z zasobem. |
| notExploitable |
Reprezentuje wpis tajny, którego nie można użyć do nawiązania połączenia z zasobem. |
| inconclusive |
Reprezentuje tajemnicę, w której nie można określić jego możliwości wykorzystania. |
| validationNotSupported |
Reprezentuje wpis tajny, w którym nie możemy zweryfikować, np. brak dynamicznego modułu sprawdzania poprawności. |
| transientError |
Reprezentuje wpis tajny, w którym proces weryfikacji zakończył się niepowodzeniem z powodu błędu przejściowego, np. problemu z siecią. Ten wynik wskazuje, że proces weryfikacji powinien zostać ponowiony. |
VersionControlDetails
Informacje dotyczące lokalizowania plików w systemie kontroli źródła
| Nazwa | Typ | Opis |
|---|---|---|
| commitHash |
string |
|
| itemUrl |
string |