Alerts - Get

Uzyskiwanie alertu.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
alertId
path True

integer (int64)

Identyfikator alertu do pobrania

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, którego częścią jest alert

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.

expand
query

ExpandOption

Rozwiń atrybuty alertu tajnego. Możliwe wartości to None i ValidationFingerprint. Wartość domyślna to None. Należy pamiętać, że jeśli expand ustawiono ValidationFingerprintwartość , odpowiedź może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tych danych należy zachować ostrożność.

ref
query

string

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
AIMetadataBlobReference

Odniesienie do blobu metadanych AI powiązanego z alertem kodu AI. Pozwala konsumentowi pobrać pełną metadaną (blob). Nie jest obsługiwane zapytanie o zawartość blobów.

Alert
AlertType

Typ alertu. Np. wpis tajny, kod itp.

AlertValidityInfo

Dane ważności alertu, który będzie częścią interfejsów API alertów i interfejsu użytkownika.

AlertValidityStatus
Confidence

Poziom ufności alertu.

DependencyKind

Rodzaj zależności tej lokalizacji logicznej.

Dismissal

Informacje o odrzucaniu alertu

DismissalType

Przyczyna zwolnienia

ExpandOption

Rozwiń atrybuty alertu tajnego. Możliwe wartości to None i ValidationFingerprint. Wartość domyślna to None. Należy pamiętać, że jeśli expand ustawiono ValidationFingerprintwartość , odpowiedź może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tych danych należy zachować ostrożność.

IdentityRef
License

Informacje o licencji dla zależności

LicenseState

Stan licencji

LicenseType

Typ 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
ValidationResult

Wynik weryfikacji.

VersionControlDetails

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

AIMetadataBlobReference

Odniesienie do blobu metadanych AI powiązanego z alertem kodu AI. Pozwala konsumentowi pobrać pełną metadaną (blob). Nie jest obsługiwane zapytanie o zawartość blobów.

Nazwa Typ Opis
downloadUrl

string

URL, aby pobrać pełną tablicę metadanych AI.

Alert

Nazwa Typ Opis
additionalInformationMessage

string

Dodatkowe komunikaty informacyjne do wyświetlenia dla tego alertu. W przypadku narzędzi ASAN zawiera szczegóły awarii sformatowane w blokach kodu. Dla narzędzi do skanowania kodu AI zawiera treści markdown z result.message.markdown.

additionalProperties

object

Dodatkowe właściwości tego alertu.

aiMetadataBlobReference

AIMetadataBlobReference

Odniesienie do metadanych AI powiązanych z alertem (tylko alerty kodu AI). Zwracane tylko na żądanie, gdy parametr Expand jest ustawiony na wartość AIMetadataBlobReference.

alertId

integer (int64)

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 (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.

hasTrustedSourceOrigin

boolean

Wartość wskazuje, czy alert pochodzi z SARIF przesłanego przez zaufane źródło.

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.

isAutoFixable

boolean

Wartość wskazuje, czy autofiks Copilot można obecnie uruchomić w alercie. Wartość true, jeśli Copilot autofiks jest dostępny dla organizacji i włączony w repozytorium, alert jest alertem skanowania kodu wykrytym przez codeQL z obsługiwaną regułą, a odwołanie alertu kwalifikuje się. Wartość null, gdy wartość nie została obliczona dla tej ścieżki kodu.

isDevDependency

boolean

Wartość wskazuje, czy alert został wygenerowany dla zależności rozwojowej. True oznacza zależność od rozwoju, false oznacza zależność w czasie działania, a null oznacza nieznane lub nieprzydatne.

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

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.

projectId

string (uuid)

Identyfikator projektu, w którym wykryto alert.

relations

RelationMetadata[]

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

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. Istnieje maksymalny limit znaków wynoszący 512.

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)

validityDetails

AlertValidityInfo

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.

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ą.

aiCode

Kod zawiera słabość zidentyfikowaną na podstawie analizy opartej na AI.

malware

Kod używa zależności oflagowane jako złośliwe oprogramowanie przez bazę danych doradczych GitHub.

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

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

DismissalType

Przyczyna zwolnienia

message

string

Komunikat informacyjny dołączony do odrzucenia

stateChangedBy

string (uuid)

Tożsamość, która odrzuciła alert

stateChangedByIdentity

IdentityRef

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.

ExpandOption

Rozwiń atrybuty alertu tajnego. Możliwe wartości to None i ValidationFingerprint. Wartość domyślna to None. Należy pamiętać, że jeśli expand ustawiono ValidationFingerprintwartość , odpowiedź może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tych danych należy zachować ostrożność.

Wartość Opis
none

Brak rozszerzeń.

validationFingerprint

Zwracanie weryfikacjiFingerprints w alercie.

aiMetadataBlobReference

Zwróć referencję do metadanych AI w Alert.

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

type

LicenseType

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

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
additionalProperties

object

Dodatkowe właściwości dotyczące miejsca znalezienia problemu

filePath

string

Ścieżka pliku, w którym znaleziono problem

isValidGitPath

boolean

Wskazuje, czy ścieżka jest prawidłową ścieżką git, która istnieje w repozytorium git skojarzonym z alertem.

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

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.

properties

object

Właściwości 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

draft

Alert jest w stanie roboczym i jest widoczny tylko dla tożsamości z listy uprzywilejowanych tożsamości draft-alert w ramach zaawansowanego bezpieczeństwa. Filtrowane spośród wszystkich odpowiedzi na alerty (wyniki i liczby) dla osób nieuprzywilejowanych.

Tool

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

Nazwa Typ Opis
isDeterministic

boolean

Czy narzędzie generuje wyniki deterministyczne. Używam do grupowania narzędzi w interfejsie filtrów alertów.

name

string

Nazwa narzędzia

rules

Rule[]

Reguły definiowane przez narzędzie

toolVersion

string

Reprezentacja ciągu wersji narzędzia

ValidationFingerprint

Nazwa Typ Opis
assetFingerprint

object

Wartość klucza reprezentująca odcisk palca elementu zawartości.

c3Id

string

Reprezentuje wartość CrossCompanyCorrelatingId dla wpisu tajnego w pliku ValidationFingerprintJson.

normalizedValidationToolVersion

integer (int32)

Znormalizowana reprezentacja ciągu wersji narzędzia sprawdzania poprawnoś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

ValidationResult

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