Alerts - List

Reference

Služba:: Advanced Security

Verze rozhraní API:: 7.2-preview.1

Získání upozornění pro úložiště

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

S volitelnými parametry:

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
repository	path	True	string	Název nebo ID úložiště
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.2-preview.1.
continuationToken	query		string	Pokud existuje více výstrah, než je možné vrátit, token pro pokračování se umístí do hlavičky x-ms-continuationtoken. Pomocí tohoto tokenu zde získáte další stránku upozornění.
criteria.alertIds	query		integer[]	Pokud je k dispozici, vrátí se pouze výstrahy se zadanými ID. V opačném případě vraťte všechny výstrahy.
criteria.alertType	query		AlertType	Pokud je k dispozici, vrátí se pouze výstrahy tohoto typu. V opačném případě vrátí výstrahy všech typů.
criteria.confidenceLevels	query		string[]	Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze na těchto úrovních spolehlivosti. Aby bylo možné načíst výstrahy všech úrovní spolehlivosti, je potřeba zadat vysokou i jinou úroveň. V opačném případě vrácené výstrahy s vysokou úrovní spolehlivosti. Platí jenom pro tajné výstrahy.
criteria.dependencyName	query		string	V případě potřeby se vrátí pouze výstrahy pro tuto závislost. V opačném případě vraťte výstrahy pro všechny závislosti. V odeslání sarif je ve výsledku zadána závislost (nebo komponenta). RelatedLocations[].logicalLocation. Nejde použít pro tajné výstrahy.
criteria.fromDate	query		string date-time	Pokud je k dispozici, vrátí se pouze výstrahy, které byly naposledy zobrazeny po tomto datu. V opačném případě se vrátí všechna upozornění.
criteria.keywords	query		string	Pokud je k dispozici, vraťte pouze výstrahy, jejichž názvy odpovídají tomuto vzoru.
criteria.licenseName	query		string	V případě potřeby se vrátí pouze výstrahy vytvořené pro závislost s touto licencí. V opačném případě vraťte upozornění pro všechny licence. V odeslání sarif je ve výsledku zadána licence pro závislost (nebo komponentu). RelatedLocations[].logicalLocation.properties.license. Nejde použít pro tajné výstrahy.
criteria.modifiedSince	query		string date-time	Pokud je k dispozici, vraťte pouze upozornění, která byla od tohoto data změněna. V opačném případě se vrátí všechna upozornění.
criteria.onlyDefaultBranch	query		boolean	Pokud je hodnota true nebo není nastavená, vrátí pouze výstrahy nalezené ve výchozí větvi úložiště. Pokud ve výchozí větvi nebyly dokončena žádná spuštění, použije se místo toho poslední spuštění bez ohledu na větev použitou pro toto spuštění. Pokud je false, vraťte výstrahy ze všech větví. Tato možnost se ignoruje, pokud je k dispozici odkaz. Nejde použít pro tajné výstrahy.
criteria.phaseId	query		string uuid	Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu. V opačném případě vrátí výstrahy zjištěné ve všech fázích. Nejde použít pro tajné výstrahy.
criteria.phaseName	query		string	Pokud je k dispozici s pipelineName, vrátí pouze výstrahy zjištěné v této fázi kanálu. V opačném případě vrátí výstrahy zjištěné ve všech fázích. Nejde použít pro tajné výstrahy.
criteria.pipelineName	query		string	Pokud je k dispozici, vrátí se v tomto kanálu pouze výstrahy. V opačném případě vrácené výstrahy zjištěné ve všech kanálech. Nejde použít pro tajné výstrahy.
criteria.ref	query		string	Pokud je k dispozici, uveďte pouze výstrahy pro tento odkaz. Pokud není k dispozici a onlyDefaultBranch je true, uveďte pouze výstrahy nalezené ve výchozí větvi nebo poslední spuštění větve, pokud pro výchozí větev neexistuje žádná konfigurace analýzy. V opačném případě zahrňte výstrahy ze všech větví. Nejde použít pro tajné výstrahy.
criteria.ruleId	query		string	Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. V opačném případě vraťte upozornění všech pravidel.
criteria.ruleName	query		string	Pokud je toto pravidlo k dispozici, vraťte pouze výstrahy. Jinak vrátí upozornění pro všechna pravidla.
criteria.severities	query		string[]	Pokud je tato výstraha za předpokladu poskytnuta, vraťte výstrahy pouze v těchto závažnostech. V opačném případě vraťte výstrahy s libovolnou závažností.
criteria.states	query		string[]	Pokud je tato výstraha za předpokladu poskytnuta, vraťte pouze výstrahy v těchto stavech. V opačném případě vraťte výstrahy v libovolném stavu.
criteria.toDate	query		string date-time	Pokud je k dispozici, vrátí se pouze výstrahy, které se naposledy zobrazily před tímto datem. V opačném případě se vrátí všechna upozornění.
criteria.toolName	query		string	Pokud je nástroj toolName k dispozici, vrátí pouze výstrahy zjištěné tímto nástrojem. V opačném případě vrátí výstrahy zjištěné všemi nástroji.
expand	query		AlertListExpandOption
orderBy	query		string	Musí být "id" "firstSeen" "lastSeen" "fixedOn" nebo "severity" Defaults to "id"
top	query		integer int32	Maximální počet výstrah, které se mají vrátit

Odpovědi

Name	Typ	Description
200 OK	Alert[]	úspěšná operace

Zabezpečení

oauth2

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

Rozsahy

Name	Description
vso.advsec	Uděluje možnost číst výstrahy, instance výsledků, instance výsledků analýzy.

Definice

Name	Description
Alert
AlertListExpandOption
AlertType	Typ výstrahy Např. tajný kód, kód atd.
AlertValidityInfo	Data platnosti výstrahy, která budou součástí rozhraní API a uživatelského rozhraní výstrah.
AlertValidityStatus
Confidence	Úroveň spolehlivosti výstrahy.
DependencyKind	Druh závislosti tohoto logického umístění
Dismissal	Informace o zavření výstrahy
DismissalType	Důvod zamítnutí
IdentityRef
License	Informace o licencích pro závislosti
LicenseState	Stav licence
LogicalLocation
PhysicalLocation	Umístění v systému správy zdrojového kódu, kde došlo k problému
ReferenceLinks	Třída představující kolekci odkazů REST.
Region
RelationMetadata	Metadata, která mají být přidružena k upozornění.
Rule	Pravidlo analýzy, které výstrahu způsobilo.
Severity	Závažnost výstrahy
State	Tato hodnota se vypočítá a vrátí službou. Je to hodnota založená na výsledcích ze všech konfigurací analýzy.
Tool	Analytický nástroj, který může generovat výstrahy zabezpečení
ValidationFingerprint
VersionControlDetails	Informace o vyhledání souborů v systému správy zdrojového kódu

Alert

Name	Typ	Description
additionalProperties	object	Další vlastnosti této výstrahy
alertId	integer	Identifikátor výstrahy. Je jedinečný v rámci organizace Azure DevOps.
alertType	AlertType	Typ výstrahy Např. tajný kód, kód atd.
confidence	Confidence	Úroveň spolehlivosti výstrahy.
dismissal	Dismissal	Obsahuje informace o zavření výstrahy, pokud byla výstraha zamítnuta.
firstSeenDate	string	Tato hodnota se vypočítá a vrátí službou. Tato hodnota představuje poprvé, kdy služba zaznamenala tento problém hlášený v instanci analýzy.
fixedDate	string	Tato hodnota se vypočítá a vrátí službou. Pokud je problém opravený, tato hodnota představuje čas, kdy služba tento problém opravila v instanci analýzy.
gitRef	string	Odkaz na objekt Gitu, např. odkaz na větev.
introducedDate	string	Tato hodnota se vypočítá a vrátí službou. Tato hodnota představuje první zavedení chyby zabezpečení.
lastSeenDate	string	Tato hodnota se vypočítá a vrátí službou. Tato hodnota představuje poslední čas, kdy služba zaznamenala tento problém hlášený v instanci analýzy.
logicalLocations	LogicalLocation[]	Logická umístění pro výstrahu Tato hodnota se vypočítá a vrátí službou. Je to hodnota založená na výsledcích ze všech konfigurací analýzy. Příkladem logického umístění je součást.
physicalLocations	PhysicalLocation[]	Tato hodnota se vypočítá a vrátí službou. Je to hodnota založená na výsledcích ze všech konfigurací analýzy. Příkladem fyzického umístění je umístění souboru.
relations	RelationMetadata[]	Vztahy mezi výstrahami a dalšími artefakty
repositoryUrl	string	Adresa URL úložiště, kde byla výstraha zjištěna.
severity	Severity	Závažnost výstrahy
state	State	Tato hodnota se vypočítá a vrátí službou. Je to hodnota založená na výsledcích ze všech konfigurací analýzy.
title	string	Nadpis se zobrazí jenom jako text a nepodporuje formátování markdownu. Maximální limit počtu znaků je 256.
tools	Tool[]	Nástroje, které tento problém zjistily
truncatedSecret	string	Zkrácená nebo obfuskovaná verze tajného kódu týkajícího se výstrahy (pokud je k dispozici).
validationFingerprints	ValidationFingerprint[]	ValidationFingerprints for the secret liveness check. Vráceno pouze na vyžádání v rozhraní Get API s parametrem Expand nastaveným na ValidationFingerprint (nevrací se v rozhraní List API)
validityDetails	AlertValidityInfo	Podrobnosti platnosti výstrahy. V současné době se to vztahuje pouze na tajné výstrahy. V případě tajných výstrah se stav platnosti a čas vypočítávají tak, že se podíváte na výsledky aktivity pro ověřovací otisky prstů přidružené k upozornění.

AlertListExpandOption

Name	Typ	Description
minimal	string	Vrátí minimální reprezentaci výstrahy.
none	string	Žádné rozbalení.

AlertType

Typ výstrahy Např. tajný kód, kód atd.

Name	Typ	Description
code	string	Kód obsahuje slabinu určenou statickou analýzou.
dependency	string	Kód používá závislost se známým ohrožením zabezpečení.
secret	string	Kód obsahuje tajný kód, který byl nyní ohrožen a musí být odvolán.
unknown	string	Kód má nezadanou chybu zabezpečení.

AlertValidityInfo

Data platnosti výstrahy, která budou součástí rozhraní API a uživatelského rozhraní výstrah.

Name	Typ	Description
validityLastCheckedDate	string
validityStatus	AlertValidityStatus

AlertValidityStatus

Name	Typ	Description
active	string
inactive	string
unknown	string

Confidence

Úroveň spolehlivosti výstrahy.

Name	Typ	Description
high	string	Vysoká úroveň spolehlivosti pro upozornění
other	string	Další úroveň spolehlivosti pro výstrahu

DependencyKind

Druh závislosti tohoto logického umístění

Name	Typ	Description
component	string	Komponenta, která je upozorňující.
rootDependency	string	Kořenová závislost zavedla výstrahu komponenty.
unknown	string
vulnerableDependency	string	Ohrožená závislost. Zastarání této hodnoty Místo toho použijte komponentu.

Dismissal

Informace o zavření výstrahy

Name	Typ	Description
dismissalId	integer	Jedinečné ID pro toto zavření
dismissalType	DismissalType	Důvod zamítnutí
message	string	Informační zpráva připojená k zavření
stateChangedBy	string	Identita, která výstrahu zavřela
stateChangedByIdentity	IdentityRef	Identita, která výstrahu zavřela

DismissalType

Důvod zamítnutí

Name	Typ	Description
acceptedRisk	string	Zavření označující, že uživatel přijímá riziko pro výstrahu
agreedToGuidance	string	Zavření označující, že uživatel souhlasí s tím, že bude postupovat podle pokynů k licencím.
falsePositive	string	Zavření označující, že výstraha je falešně pozitivní a pravděpodobně nebude opravena.
fixed	string	Zavření označující, že byla opravena výstraha
unknown	string	Neznámý typ zavření

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

License

Informace o licencích pro závislosti

Name	Typ	Description
name	string	Název licence
state	LicenseState	Stav licence
url	string	Adresa URL informací o licenci

LicenseState

Stav licence

Name	Typ	Description
harvested	string	Informace o licenci získala společnost ClearlyDefined
notHarvested	string	Informace o licenci nebyly získány programem ClearlyDefined
unknown	string	Informace o licenci nebyly získány programem ClearlyDefined

LogicalLocation

Name	Typ	Description
fullyQualifiedName	string
kind	DependencyKind	Druh závislosti tohoto logického umístění
license	License	Informace o licenci pro závislost platí pouze v případě, že druh je komponenta a alertType výstrahy s tímto umístěním je Licence.

PhysicalLocation

Umístění v systému správy zdrojového kódu, kde došlo k problému

Name	Typ	Description
filePath	string	Cesta k souboru, ve kterém došlo k problému
region	Region	Podrobnosti o umístění, kde byl problém nalezen, včetně fragmentu kódu
versionControl	VersionControlDetails	Informace o umístění specifické pro systém správy zdrojového kódu

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

Region

Name	Typ	Description
columnEnd	integer	Sloupec, na kterém končí fragment kódu
columnStart	integer	Sloupec, kde fragment kódu začíná
lineEnd	integer	Číslo řádku, kde fragment kódu končí
lineStart	integer	Číslo řádku, kde fragment kódu začíná

RelationMetadata

Metadata, která mají být přidružena k upozornění.

Name	Typ	Description
attributes	object	Všechny další atributy metadat.
rel	string	Typ metadat.
url	string	Adresa URL metadat.

Rule

Pravidlo analýzy, které výstrahu způsobilo.

Name	Typ	Description
additionalProperties	object	Další vlastnosti tohoto pravidla závislé na typu pravidla. Pravidla závislostí můžou například obsahovat ID CVE, pokud je k dispozici.
description	string	Popis toho, co toto pravidlo detekuje
friendlyName	string	Identifikátor pravidla prostého textu
helpMessage	string	Další informace o tomto pravidlu
opaqueId	string	Identifikátor pravidla specifického pro nástroj
resources	string	Seznam prostředků formátovaných markdownem, kde najdete další informace o pravidle. V některých případech se místo toho používá RuleInfo.AdditionalProperties.advisoryUrls.
tags	string[]	Značky klasifikace pro toto pravidlo

Severity

Závažnost výstrahy

Name	Typ	Description
critical	string
error	string
high	string
low	string
medium	string
note	string
undefined	string
warning	string

State

Tato hodnota se vypočítá a vrátí službou. Je to hodnota založená na výsledcích ze všech konfigurací analýzy.

Name	Typ	Description
active	string	V kódu byla zjištěna výstraha.
autoDismissed	string	Nástroj zjistil, že problém již nepředstavuje riziko.
dismissed	string	Výstraha byla zamítnuta uživatelem
fixed	string	Problém se už v kódu nezjistí.
unknown	string	Výstraha je v neurčitém stavu

Tool

Analytický nástroj, který může generovat výstrahy zabezpečení

Name	Typ	Description
name	string	Název nástroje
rules	Rule[]	Pravidla, která nástroj definuje

ValidationFingerprint

Name	Typ	Description
validationFingerprintHash	string
validationFingerprintJson	string
validityLastUpdatedDate	string
validityResult	string

VersionControlDetails

Informace o vyhledání souborů v systému správy zdrojového kódu

Name	Typ	Description
commitHash	string
itemUrl	string

Sdílet prostřednictvím