Alerts - List
Hämta aviseringar för en lagringsplats
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.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}&continuationToken={continuationToken}&api-version=7.2-preview.1
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Namnet på Azure DevOps-organisationen. |
project
|
path | True |
string |
Projekt-ID eller projektnamn |
repository
|
path | True |
string |
Lagringsplatsens namn eller ID |
api-version
|
query | True |
string |
Version av API:et som ska användas. Detta bör anges till "7.2-preview.1" för att använda den här versionen av API:et. |
continuation
|
query |
string |
Om det finns fler aviseringar än vad som kan returneras placeras en fortsättningstoken i rubriken "x-ms-continuationtoken". Använd den token här för att hämta nästa sida med aviseringar |
|
criteria.
|
query |
integer[] |
Om detta anges returnerar du endast aviseringar med angivna ID:t. |
|
criteria.
|
query |
Om detta anges returnerar du endast aviseringar av den här typen. Annars returnerar du aviseringar av alla typer. |
||
criteria.
|
query |
string[] |
Om detta anges returnerar du endast aviseringar på dessa konfidensnivåer. |
|
criteria.
|
query |
string |
Om detta anges returneras endast aviseringar för det här beroendet. |
|
criteria.
|
query |
string date-time |
Om detta anges returnerar du endast aviseringar som senast sågs efter det här datumet. |
|
criteria.
|
query |
string |
Om detta anges returnerar du endast aviseringar vars rubriker matchar det här mönstret. |
|
criteria.
|
query |
string |
Om detta anges returneras endast aviseringar som skapats för beroende med den här licensen. |
|
criteria.
|
query |
string date-time |
Om detta anges returnerar du endast aviseringar som har ändrats sedan det här datumet. |
|
criteria.
|
query |
boolean |
Om sant eller inte anges returnerar du bara aviseringar som finns på standardgrenen för lagringsplatsen. |
|
criteria.
|
query |
string uuid |
Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen |
|
criteria.
|
query |
string |
Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen |
|
criteria.
|
query |
string |
Om det tillhandahålls returnerar du endast aviseringar som identifierats i den här pipelinen. |
|
criteria.
|
query |
string |
Om detta anges inkluderar du endast aviseringar för den här referensen. |
|
criteria.
|
query |
string |
Om detta anges returnerar du endast aviseringar för den här regeln. |
|
criteria.
|
query |
string |
Om detta anges returnerar du endast aviseringar för den här regeln. |
|
criteria.
|
query |
string[] |
Om detta anges returnerar du endast aviseringar med dessa allvarlighetsgrader. |
|
criteria.
|
query |
string[] |
Om detta anges returnerar du endast aviseringar i dessa tillstånd. |
|
criteria.
|
query |
string date-time |
Om detta anges returnerar du endast aviseringar som senast setts före det här datumet. |
|
criteria.
|
query |
string |
Om det tillhandahålls med toolName returnerar du endast aviseringar som identifierats av det här verktyget. |
|
order
|
query |
string |
Måste vara "id" "firstSeen" "lastSeen" "fixedOn" eller "severity" Defaults to "id" |
|
top
|
query |
integer int32 |
Det maximala antalet aviseringar som ska returneras |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Alert[] |
lyckad åtgärd |
Säkerhet
oauth2
Typ:
oauth2
Flow:
accessCode
Auktoriseringswebbadress:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-webbadress:
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
Omfattningar
Name | Description |
---|---|
vso.advsec | Ger möjlighet att läsa aviseringar, resultatinstanser, analysresultatinstanser |
Definitioner
Name | Description |
---|---|
Alert | |
Alert |
Typ av avisering. T.ex. hemlighet, kod osv. |
Confidence |
Aviseringens konfidensnivå. |
Dependency |
Beroendetyp för den här logiska platsen. |
Dismissal |
Information om uppsägning av aviseringar |
Dismissal |
Orsak till uppsägningen |
Identity |
|
License |
Licensinformation för beroenden |
License |
Licenstillstånd |
Logical |
|
Physical |
Plats i källkontrollsystemet där problemet hittades |
Reference |
Klassen som representerar en samling REST-referenslänkar. |
Region | |
Relation |
Metadata som ska associeras med aviseringen. |
Rule |
Analysregeln som orsakade aviseringen. |
Severity |
Allvarlighetsgrad för aviseringen. |
State |
Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer. |
Tool |
Ett analysverktyg som kan generera säkerhetsaviseringar |
Validation |
|
Version |
Information för att hitta filer i ett källkontrollsystem |
Alert
Name | Typ | Description |
---|---|---|
alertId |
integer |
Identifierare för aviseringen. Det är unqiue i Azure DevOps-organisationen. |
alertType |
Typ av avisering. T.ex. hemlighet, kod osv. |
|
confidence |
Aviseringens konfidensnivå. |
|
dismissal |
Innehåller information om uppsägning av aviseringen om aviseringen har avvisats. |
|
firstSeenDate |
string |
Det här värdet beräknas och returneras av tjänsten. Det här värdet representerar första gången tjänsten har sett det här problemet rapporteras i en analysinstans. |
fixedDate |
string |
Det här värdet beräknas och returneras av tjänsten. Om problemet är åtgärdat representerar det här värdet den tid då tjänsten har sett problemet åtgärdats i en analysinstans. |
gitRef |
string |
Referens till ett git-objekt, t.ex. grenreferens. |
introducedDate |
string |
Det här värdet beräknas och returneras av tjänsten. Det här värdet representerar första gången sårbarheten introducerades. |
lastSeenDate |
string |
Det här värdet beräknas och returneras av tjänsten. Det här värdet representerar den senaste gången tjänsten har sett det här problemet rapporteras i en analysinstans. |
logicalLocations |
Logiska platser för aviseringen. Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer. Ett exempel på en logisk plats är en komponent. |
|
physicalLocations |
Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer. Ett exempel på en fysisk plats är en filplats. |
|
relations |
Relationer mellan aviseringar och andra artefakter. |
|
repositoryUrl |
string |
Url till lagringsplatsen där aviseringen upptäcktes. |
severity |
Allvarlighetsgrad för aviseringen. |
|
state |
Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer. |
|
title |
string |
Rubrik återges endast som text och stöder inte markdown-formatering. Det finns en maximal teckengräns på 256. |
tools |
Tool[] |
Verktyg som har identifierat det här problemet. |
truncatedSecret |
string |
En trunkerad/dold version av hemligheten som rör aviseringen (om tillämpligt). |
validationFingerprints |
ValidationFingerprints för den hemliga liveness-kontrollen. Returneras endast på begäran i Hämta API med expanderingsparameter inställd på ValidationFingerprint (returneras inte i list-API) |
AlertType
Typ av avisering. T.ex. hemlighet, kod osv.
Name | Typ | Description |
---|---|---|
code |
string |
Koden innehåller en svaghet som bestäms av statisk analys. |
dependency |
string |
Koden använder ett beroende med en känd säkerhetsrisk. |
license |
string |
Koden använder ett beroende med potentiell licensinkompatibilitet. |
secret |
string |
Koden innehåller en hemlighet som nu har komprometterats och måste återkallas. |
unknown |
string |
Koden har en ospecificerad sårbarhetstyp |
Confidence
Aviseringens konfidensnivå.
Name | Typ | Description |
---|---|---|
high |
string |
Hög konfidensnivå för avisering |
other |
string |
Annan konfidensnivå för avisering |
DependencyKind
Beroendetyp för den här logiska platsen.
Name | Typ | Description |
---|---|---|
component |
string |
Komponenten som aviseras. |
rootDependency |
string |
Rotberoendet introducerade komponenten som aviseras. |
unknown |
string |
|
vulnerableDependency |
string |
Sårbart beroende. Inaktuellt värde. Använd Komponent i stället. |
Dismissal
Information om uppsägning av aviseringar
Name | Typ | Description |
---|---|---|
dismissalId |
integer |
Unikt ID för denna uppsägning |
dismissalType |
Orsak till uppsägningen |
|
message |
string |
Informationsmeddelande som bifogas uppsägningen |
stateChangedBy |
string |
Identitet som avvisade aviseringen |
stateChangedByIdentity |
Identitet som avvisade aviseringen |
DismissalType
Orsak till uppsägningen
Name | Typ | Description |
---|---|---|
acceptedRisk |
string |
Uppsägning som anger att användaren accepterar en risk för aviseringen |
agreedToGuidance |
string |
Uppsägning som anger att användaren samtycker till att följa licensvägledningen. |
falsePositive |
string |
Uppsägning som anger aviseringen är en falsk positiv och kommer sannolikt inte att åtgärdas. |
fixed |
string |
Uppsägning som anger att aviseringen har åtgärdats |
unknown |
string |
Uppsägningstyp okänd |
IdentityRef
Name | Typ | Description |
---|---|---|
_links |
Det här fältet innehåller noll eller fler intressanta länkar om grafämnet. Dessa länkar kan anropas för att hämta ytterligare relationer eller mer detaljerad information om det här grafämnet. |
|
descriptor |
string |
Beskrivningen är det primära sättet att referera till grafämnet medan systemet körs. Det här fältet identifierar unikt samma grafämne i både konton och organisationer. |
directoryAlias |
string |
Inaktuell – Kan hämtas genom att fråga Graph-användaren som refereras i "själv"-posten i ordlistan IdentityRef "_links" |
displayName |
string |
Det här är grafämnets icke-unika visningsnamn. Om du vill ändra det här fältet måste du ändra dess värde i källprovidern. |
id |
string |
|
imageUrl |
string |
Inaktuell – Tillgänglig i "avatar"-posten i ordlistan IdentityRef "_links" |
inactive |
boolean |
Inaktuell – Kan hämtas genom att fråga graphmedlemskapstillståndet som refereras i posten "membershipState" i ordlistan GraphUser "_links" |
isAadIdentity |
boolean |
Inaktuell – Kan härledas från ämnestypen för beskrivningen (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Inaktuell – Kan härledas från ämnestypen för beskrivningen (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Inaktuell – används inte i de flesta befintliga implementeringar av ToIdentityRef |
uniqueName |
string |
Inaktuell – använd Domain+PrincipalName i stället |
url |
string |
Den här URL:en är den fullständiga vägen till källresursen för det här grafämnet. |
License
Licensinformation för beroenden
Name | Typ | Description |
---|---|---|
name |
string |
Licensnamn |
state |
Licenstillstånd |
|
url |
string |
Url för licensinformation |
LicenseState
Licenstillstånd
Name | Typ | Description |
---|---|---|
harvested |
string |
Information om licensen har skördats av ClearlyDefined |
notHarvested |
string |
Information om licensen har inte skördats av ClearlyDefined |
unknown |
string |
Information om licensen har inte skördats av ClearlyDefined |
LogicalLocation
Name | Typ | Description |
---|---|---|
fullyQualifiedName |
string |
|
kind |
Beroendetyp för den här logiska platsen. |
|
license |
Licensinformation för Beroende gäller endast när Kind är "Komponent" och alertType för aviseringen med den här platsen är Licens |
PhysicalLocation
Plats i källkontrollsystemet där problemet hittades
Name | Typ | Description |
---|---|---|
filePath |
string |
Sökvägen till filen där problemet hittades |
region |
Information om platsen där problemet hittades, inklusive ett kodfragment |
|
versionControl |
Systemspecifik information om källkontroll om platsen |
ReferenceLinks
Klassen som representerar en samling REST-referenslänkar.
Name | Typ | Description |
---|---|---|
links |
object |
Läsvyn över länkarna. Eftersom referenslänkar är skrivskyddade vill vi bara exponera dem som skrivskyddade. |
Region
Name | Typ | Description |
---|---|---|
columnEnd |
integer |
Kolumnen där kodfragmentet slutar |
columnStart |
integer |
Kolumnen där kodfragmentet startar |
lineEnd |
integer |
Radnumret där kodfragmentet slutar |
lineStart |
integer |
Radnumret där kodfragmentet startar |
RelationMetadata
Metadata som ska associeras med aviseringen.
Name | Typ | Description |
---|---|---|
attributes |
object |
Eventuella ytterligare attribut för metadata. |
rel |
string |
Typ av metadata. |
url |
string |
URL:en för metadata. |
Rule
Analysregeln som orsakade aviseringen.
Name | Typ | Description |
---|---|---|
additionalProperties |
object |
Ytterligare egenskaper för den här regeln är beroende av regeltypen. Beroenderegler kan till exempel innehålla CVE-ID:t om det är tillgängligt. |
description |
string |
Beskrivning av vad den här regeln identifierar |
friendlyName |
string |
Oformaterad regelidentifierare |
helpMessage |
string |
Ytterligare information om den här regeln |
opaqueId |
string |
Verktygsspecifik regelidentifierare |
resources |
string |
Markdown-formaterad lista över resurser för att lära dig mer om regeln. I vissa fall används RuleInfo.AdditionalProperties.advisoryUrls i stället. |
tags |
string[] |
Klassificeringstaggar för den här regeln |
Severity
Allvarlighetsgrad för aviseringen.
Name | Typ | Description |
---|---|---|
critical |
string |
|
error |
string |
|
high |
string |
|
low |
string |
|
medium |
string |
|
note |
string |
|
undefined |
string |
|
warning |
string |
State
Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer.
Name | Typ | Description |
---|---|---|
active |
string |
Aviseringen har identifierats i koden |
autoDismissed |
string |
Verktyget har fastställt att problemet inte längre är en risk |
dismissed |
string |
Aviseringen har avvisats av en användare |
fixed |
string |
Problemet identifieras inte längre i koden |
unknown |
string |
Aviseringen är i ett obestämt tillstånd |
Tool
Ett analysverktyg som kan generera säkerhetsaviseringar
Name | Typ | Description |
---|---|---|
name |
string |
Verktygets namn |
rules |
Rule[] |
De regler som verktyget definierar |
ValidationFingerprint
Name | Typ | Description |
---|---|---|
validationFingerprintHash |
string |
|
validationFingerprintJson |
string |
VersionControlDetails
Information för att hitta filer i ett källkontrollsystem
Name | Typ | Description |
---|---|---|
commitHash |
string |
|
itemUrl |
string |