Dela via

Alerts - List

  • Referens
Tjänst:
Advanced Security
API-version:
7.2-preview.1

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
Med valfria parametrar: 
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.
continuationToken
 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.alertIds
 query

integer[]

Om detta anges returnerar du endast aviseringar med angivna ID:t.
Annars returnerar du alla aviseringar.
criteria.alertType
 query

AlertType

Om detta anges returnerar du endast aviseringar av den här typen. Annars returnerar du aviseringar av alla typer.
criteria.confidenceLevels
 query

string[]

Om detta anges returnerar du endast aviseringar på dessa konfidensnivåer.
Både Hög och Annan måste anges för att hämta aviseringar om alla konfidensnivåer.
Annars returnerar du aviseringar med hög konfidensnivå.
criteria.dependencyName
 query

string

Om detta anges returneras endast aviseringar för det här beroendet.
Annars returnerar du aviseringar för alla beroenden.
I en sarif-överföring anges ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation.
criteria.fromDate
 query

string

date-time

Om detta anges returnerar du endast aviseringar som senast sågs efter det här datumet.
Annars returnerar du alla aviseringar.
criteria.keywords
 query

string

Om detta anges returnerar du endast aviseringar vars rubriker matchar det här mönstret.
criteria.licenseName
 query

string

Om detta anges returneras endast aviseringar som skapats för beroende med den här licensen.
Annars returnerar du aviseringar för alla licenser.
I en sarif-överföring anges licensen för ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation.properties.license.
criteria.modifiedSince
 query

string

date-time

Om detta anges returnerar du endast aviseringar som har ändrats sedan det här datumet.
Annars returnerar du alla aviseringar.
criteria.onlyDefaultBranch
 query

boolean

Om sant eller inte anges returnerar du bara aviseringar som finns på standardgrenen för lagringsplatsen.
Om inga körningar har slutförts på standardgrenen används den senaste körningen i stället oavsett vilken gren som används för den körningen. Om det är falskt returnerar du aviseringar från alla grenar.
Det här alternativet ignoreras om referens anges.
criteria.phaseId
 query

string

uuid

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen
Annars returnerar du aviseringar som identifierats i alla faser.
criteria.phaseName
 query

string

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen
Annars returnerar du aviseringar som identifierats i alla faser.
criteria.pipelineName
 query

string

Om det tillhandahålls returnerar du endast aviseringar som identifierats i den här pipelinen.
Annars returnerar du aviseringar som identifierats i alla pipelines.
criteria.ref
 query

string

Om detta anges inkluderar du endast aviseringar för den här referensen.
Om det inte anges och OnlyDefaultBranch är sant inkluderar du bara aviseringar som finns på standardgrenen eller den senaste körningsgrenen om det inte finns någon analyskonfiguration för standardgrenen.
I annat fall inkluderar du aviseringar från alla grenar.
criteria.ruleId
 query

string

Om detta anges returnerar du endast aviseringar för den här regeln.
Annars returnerar du aviseringar för alla regler.
criteria.ruleName
 query

string

Om detta anges returnerar du endast aviseringar för den här regeln.
Annars returnerar du aviseringar för alla regler.
criteria.severities
 query

string[]

Om detta anges returnerar du endast aviseringar med dessa allvarlighetsgrader.
Annars returnerar du aviseringar på valfri serveritet.
criteria.states
 query

string[]

Om detta anges returnerar du endast aviseringar i dessa tillstånd.
Annars returnerar du aviseringar i alla tillstånd.
criteria.toDate
 query

string

date-time

Om detta anges returnerar du endast aviseringar som senast setts före det här datumet.
Annars returnerar du alla aviseringar.
criteria.toolName
 query

string

Om det tillhandahålls med toolName returnerar du endast aviseringar som identifierats av det här verktyget.
Annars returnerar du aviseringar som identifierats av alla verktyg.
orderBy
 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
AlertType

Typ av avisering. T.ex. hemlighet, kod osv.
Confidence

Aviseringens konfidensnivå.
DependencyKind

Beroendetyp för den här logiska platsen.
Dismissal

Information om uppsägning av aviseringar
DismissalType

Orsak till uppsägningen
IdentityRef
License

Licensinformation för beroenden
LicenseState

Licenstillstånd
LogicalLocation
PhysicalLocation

Plats i källkontrollsystemet där problemet hittades
ReferenceLinks

Klassen som representerar en samling REST-referenslänkar.
Region
RelationMetadata

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
ValidationFingerprint
VersionControlDetails

Information för att hitta filer i ett källkontrollsystem

Alert

Objekt
Name Typ Description
alertId

integer

Identifierare för aviseringen. Det är unqiue i Azure DevOps-organisationen.
alertType

AlertType

Typ av avisering. T.ex. hemlighet, kod osv.
confidence

Confidence

Aviseringens konfidensnivå.
dismissal

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

LogicalLocation[]

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

PhysicalLocation[]

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

RelationMetadata[]

Relationer mellan aviseringar och andra artefakter.
repositoryUrl

string

Url till lagringsplatsen där aviseringen upptäcktes.
severity

Severity

Allvarlighetsgrad för aviseringen.
state

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

ValidationFingerprint[]

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

Uppräkning

Typ av avisering. T.ex. hemlighet, kod osv.

Värde Description
code

Koden innehåller en svaghet som bestäms av statisk analys.
dependency

Koden använder ett beroende med en känd säkerhetsrisk.
license

Koden använder ett beroende med potentiell licensinkompatibilitet.
secret

Koden innehåller en hemlighet som nu har komprometterats och måste återkallas.
unknown

Koden har en ospecificerad sårbarhetstyp

Confidence

Uppräkning

Aviseringens konfidensnivå.

Värde Description
high

Hög konfidensnivå för avisering
other

Annan konfidensnivå för avisering

DependencyKind

Uppräkning

Beroendetyp för den här logiska platsen.

Värde Description
component

Komponenten som aviseras.
rootDependency

Rotberoendet introducerade komponenten som aviseras.
unknown
vulnerableDependency

Sårbart beroende. Inaktuellt värde. Använd Komponent i stället.

Dismissal

Objekt

Information om uppsägning av aviseringar

Name Typ Description
dismissalId

integer

Unikt ID för denna uppsägning
dismissalType

DismissalType

Orsak till uppsägningen
message

string

Informationsmeddelande som bifogas uppsägningen
stateChangedBy

string

Identitet som avvisade aviseringen
stateChangedByIdentity

IdentityRef

Identitet som avvisade aviseringen

DismissalType

Uppräkning

Orsak till uppsägningen

Värde Description
acceptedRisk

Uppsägning som anger att användaren accepterar en risk för aviseringen
agreedToGuidance

Uppsägning som anger att användaren samtycker till att följa licensvägledningen.
falsePositive

Uppsägning som anger aviseringen är en falsk positiv och kommer sannolikt inte att åtgärdas.
fixed

Uppsägning som anger att aviseringen har åtgärdats
unknown

Uppsägningstyp okänd

IdentityRef

Objekt
Name Typ Description
_links

ReferenceLinks

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

Objekt

Licensinformation för beroenden

Name Typ Description
name

string

Licensnamn
state

LicenseState

Licenstillstånd
url

string

Url för licensinformation

LicenseState

Uppräkning

Licenstillstånd

Värde Description
harvested

Information om licensen har skördats av ClearlyDefined
notHarvested

Information om licensen har inte skördats av ClearlyDefined
unknown

Information om licensen har inte skördats av ClearlyDefined

LogicalLocation

Objekt
Name Typ Description
fullyQualifiedName

string

kind

DependencyKind

Beroendetyp för den här logiska platsen.
license

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

Objekt

Plats i källkontrollsystemet där problemet hittades

Name Typ Description
filePath

string

Sökvägen till filen där problemet hittades
region

Region

Information om platsen där problemet hittades, inklusive ett kodfragment
versionControl

VersionControlDetails

Systemspecifik information om källkontroll om platsen
Objekt

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

Objekt
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

Objekt

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

Objekt

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

Uppräkning

Allvarlighetsgrad för aviseringen.

Värde Description
critical
error
high
low
medium
note
undefined
warning

State

Uppräkning

Det här värdet beräknas och returneras av tjänsten. Det är ett värde baserat på resultaten från alla analyskonfigurationer.

Värde Description
active

Aviseringen har identifierats i koden
autoDismissed

Verktyget har fastställt att problemet inte längre är en risk
dismissed

Aviseringen har avvisats av en användare
fixed

Problemet identifieras inte längre i koden
unknown

Aviseringen är i ett obestämt tillstånd

Tool

Objekt

Ett analysverktyg som kan generera säkerhetsaviseringar

Name Typ Description
name

string

Verktygets namn
rules

Rule[]

De regler som verktyget definierar

ValidationFingerprint

Objekt
Name Typ Description
validationFingerprintHash

string

validationFingerprintJson

string

VersionControlDetails

Objekt

Information för att hitta filer i ett källkontrollsystem

Name Typ Description
commitHash

string

itemUrl

string