Alerts - List

Service:

Advanced Security

API-versie:

7.2-preview.1

Waarschuwingen voor een opslagplaats ophalen

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

Met optionele parameters:

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-parameters

Name	In	Vereist	Type	Description
organization	path	True	string	De naam van de Azure DevOps-organisatie.
project	path	True	string	Project-id of projectnaam
repository	path	True	string	De naam of id van de opslagplaats
api-version	query	True	string	De versie van de API die moet worden gebruikt. Deze moet worden ingesteld op '7.2-preview.1' om deze versie van de API te gebruiken.
continuationToken	query		string	Als er meer waarschuwingen zijn dan kan worden geretourneerd, wordt een vervolgtoken in de header x-ms-continuationtoken geplaatst. Gebruik dit token hier om de volgende pagina met waarschuwingen op te halen
criteria.alertIds	query		integer[]	Indien opgegeven, retourneert u alleen waarschuwingen met de opgegeven id's. Anders retourneert u een waarschuwing.
criteria.alertType	query		AlertType	Indien opgegeven, retourneert u alleen waarschuwingen van dit type. Anders retourneert u waarschuwingen van alle typen.
criteria.confidenceLevels	query		string[]	Indien opgegeven, retourneert u alleen waarschuwingen op deze betrouwbaarheidsniveaus. Zowel Hoog als Overige moeten worden opgegeven om waarschuwingen van alle betrouwbaarheidsniveaus op te halen. Anders retourneert u waarschuwingen met een hoog betrouwbaarheidsniveau.
criteria.dependencyName	query		string	Indien opgegeven, worden alleen waarschuwingen voor deze afhankelijkheid geretourneerd. Anders retourneert u waarschuwingen voor alle afhankelijkheden. In een sarif-inzending wordt een afhankelijkheid (of een onderdeel) opgegeven in het resultaat. RelatedLocations[].logicalLocation.
criteria.fromDate	query		string date-time	Indien opgegeven, retourneert u alleen waarschuwingen die na deze datum voor het laatst zijn gezien. Anders worden alle waarschuwingen geretourneerd.
criteria.keywords	query		string	Indien opgegeven, worden alleen waarschuwingen geretourneerd waarvan de titels overeenkomen met dit patroon.
criteria.licenseName	query		string	Indien opgegeven, worden alleen waarschuwingen geretourneerd die zijn gemaakt voor afhankelijkheid met deze licentie. Anders retourneert u waarschuwingen voor alle licenties. In een sarif-inzending wordt een licentie voor een afhankelijkheid (of een onderdeel) opgegeven in het resultaat. RelatedLocations[].logicalLocation.properties.license.
criteria.modifiedSince	query		string date-time	Indien opgegeven, worden alleen waarschuwingen geretourneerd die zijn gewijzigd sinds deze datum. Anders worden alle waarschuwingen geretourneerd.
criteria.onlyDefaultBranch	query		boolean	Als waar of niet is ingesteld, worden alleen waarschuwingen geretourneerd die zijn gevonden in de standaardbranch van de opslagplaats. Als er geen uitvoeringen zijn voltooid in de standaardbranch, wordt de laatste uitvoering gebruikt, ongeacht de vertakking die voor die uitvoering wordt gebruikt. Als dit onwaar is, retourneert u waarschuwingen van alle vertakkingen. Deze optie wordt genegeerd als verw is opgegeven.
criteria.phaseId	query		string uuid	Als deze is opgegeven met pipelineName, retourneert u alleen waarschuwingen die in deze pijplijnfase zijn gedetecteerd Anders retourneert u waarschuwingen die in alle fasen zijn gedetecteerd.
criteria.phaseName	query		string	Als deze is opgegeven met pipelineName, retourneert u alleen waarschuwingen die in deze pijplijnfase zijn gedetecteerd Anders retourneert u waarschuwingen die in alle fasen zijn gedetecteerd.
criteria.pipelineName	query		string	Indien opgegeven, retourneert u alleen waarschuwingen die in deze pijplijn zijn gedetecteerd. Anders retourneert u waarschuwingen die in alle pijplijnen zijn gedetecteerd.
criteria.ref	query		string	Indien opgegeven, neemt u alleen waarschuwingen op voor deze ref. Als dit niet is opgegeven en OnlyDefaultBranch waar is, neemt u alleen waarschuwingen op die zijn gevonden in de standaardbranch of laatste uitvoeringsbranch als er geen analyseconfiguratie is voor de standaardbranch. Neem anders waarschuwingen van alle vertakkingen op.
criteria.ruleId	query		string	Indien opgegeven, retourneert u alleen waarschuwingen voor deze regel. Anders retourneert u waarschuwingen van alle regels.
criteria.ruleName	query		string	Indien opgegeven, retourneert u alleen waarschuwingen voor deze regel. Anders retourneert u waarschuwingen voor alle regels.
criteria.severities	query		string[]	Indien opgegeven, retourneert u alleen waarschuwingen met deze ernst. Anders retourneert u waarschuwingen op serveriteit.
criteria.states	query		string[]	Indien opgegeven, retourneert u alleen waarschuwingen in deze statussen. Anders retourneert u waarschuwingen in een willekeurige status.
criteria.toDate	query		string date-time	Indien opgegeven, retourneert u alleen waarschuwingen die vóór deze datum zijn gezien. Anders worden alle waarschuwingen geretourneerd.
criteria.toolName	query		string	Als u met toolName wordt geleverd, worden alleen waarschuwingen geretourneerd die door dit hulpprogramma zijn gedetecteerd. Anders retourneert u waarschuwingen die door alle hulpprogramma's zijn gedetecteerd.
orderBy	query		string	Moet 'id' 'firstSeen' 'lastSeen' 'fixedOn' of 'ernst' zijn, wordt standaard ingesteld op 'id'
top	query		integer int32	Het maximum aantal waarschuwingen dat moet worden geretourneerd

Antwoorden

Name	Type	Description
200 OK	Alert[]	geslaagde bewerking

Beveiliging

oauth2

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-URL: 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

Bereiken

Name	Description
vso.advsec	Verleent de mogelijkheid om waarschuwingen, resultaatexemplaren, analyseresultatenexemplaren te lezen

Definities

Name	Description
Alert
AlertType	Type waarschuwing. Bijvoorbeeld geheim, code, enzovoort.
Confidence	Betrouwbaarheidsniveau van de waarschuwing.
DependencyKind	Afhankelijkheidstype van deze logische locatie.
Dismissal	Informatie over een waarschuwingsontzegging
DismissalType	Reden voor ontslag
IdentityRef
License	Licentiegegevens voor afhankelijkheden
LicenseState	Licentiestatus
LogicalLocation
PhysicalLocation	Locatie in het broncodebeheersysteem waar het probleem is gevonden
ReferenceLinks	De klasse die een verzameling REST-verwijzingskoppelingen vertegenwoordigt.
Region
RelationMetadata	De metagegevens die aan de waarschuwing moeten worden gekoppeld.
Rule	De analyseregel die de waarschuwing heeft veroorzaakt.
Severity	Ernst van de waarschuwing.
State	Deze waarde wordt berekend en geretourneerd door de service. Het is een waarde op basis van de resultaten van alle analyseconfiguraties.
Tool	Een analysehulpprogramma waarmee beveiligingswaarschuwingen kunnen worden gegenereerd
ValidationFingerprint
VersionControlDetails	Informatie over het vinden van bestanden in een broncodebeheersysteem

Alert

Name	Type	Description
alertId	integer	Id voor de waarschuwing. Dit is niet mogelijk binnen de Azure DevOps-organisatie.
alertType	AlertType	Type waarschuwing. Bijvoorbeeld geheim, code, enzovoort.
confidence	Confidence	Betrouwbaarheidsniveau van de waarschuwing.
dismissal	Dismissal	Bevat informatie over het ontslag van de waarschuwing als de waarschuwing is gesloten.
firstSeenDate	string	Deze waarde wordt berekend en geretourneerd door de service. Deze waarde vertegenwoordigt de eerste keer dat de service dit probleem heeft gezien dat in een analyse-exemplaar is gerapporteerd.
fixedDate	string	Deze waarde wordt berekend en geretourneerd door de service. Als het probleem is opgelost, vertegenwoordigt deze waarde het tijdstip waarop het probleem door de service is opgelost in een analyse-exemplaar.
gitRef	string	Verwijzing naar een Git-object, bijvoorbeeld vertakkingsverwijzing.
introducedDate	string	Deze waarde wordt berekend en geretourneerd door de service. Deze waarde vertegenwoordigt de eerste keer dat het beveiligingsprobleem is geïntroduceerd.
lastSeenDate	string	Deze waarde wordt berekend en geretourneerd door de service. Deze waarde vertegenwoordigt de laatste keer dat de service dit probleem heeft gerapporteerd in een analyse-exemplaar.
logicalLocations	LogicalLocation[]	Logische locaties voor de waarschuwing. Deze waarde wordt berekend en geretourneerd door de service. Het is een waarde op basis van de resultaten van alle analyseconfiguraties. Een voorbeeld van een logische locatie is een onderdeel.
physicalLocations	PhysicalLocation[]	Deze waarde wordt berekend en geretourneerd door de service. Het is een waarde op basis van de resultaten van alle analyseconfiguraties. Een voorbeeld van een fysieke locatie is een bestandslocatie.
relations	RelationMetadata[]	Relaties tussen waarschuwingen en andere artefacten.
repositoryUrl	string	URL van opslagplaats waar de waarschuwing is gedetecteerd.
severity	Severity	Ernst van de waarschuwing.
state	State	Deze waarde wordt berekend en geretourneerd door de service. Het is een waarde op basis van de resultaten van alle analyseconfiguraties.
title	string	Titel wordt alleen weergegeven als tekst en biedt geen ondersteuning voor markdown-opmaak. Er geldt een maximumtekenlimiet van 256.
tools	Tool[]	Hulpprogramma's die dit probleem hebben gedetecteerd.
truncatedSecret	string	Een afgekapte/verborgen versie van het geheim met betrekking tot de waarschuwing (indien van toepassing).
validationFingerprints	ValidationFingerprint[]	ValidatieFingerprints voor de controle van de geheime liveness. Alleen geretourneerd op aanvraag in Get API met de parameter Expand ingesteld op ValidatieFingerprint (niet geretourneerd in list-API)

AlertType

Type waarschuwing. Bijvoorbeeld geheim, code, enzovoort.

Name	Type	Description
code	string	De code bevat een zwakke plek die wordt bepaald door statische analyse.
dependency	string	De code maakt gebruik van een afhankelijkheid met een bekend beveiligingsprobleem.
license	string	De code maakt gebruik van een afhankelijkheid met mogelijke incompliance van licenties.
secret	string	De code bevat een geheim dat nu is aangetast en moet worden ingetrokken.
unknown	string	De code heeft een niet-opgegeven type beveiligingsprobleem

Confidence

Betrouwbaarheidsniveau van de waarschuwing.

Name	Type	Description
high	string	Hoog betrouwbaarheidsniveau voor waarschuwing
other	string	Ander betrouwbaarheidsniveau voor waarschuwing

DependencyKind

Afhankelijkheidstype van deze logische locatie.

Name	Type	Description
component	string	Het onderdeel wordt gewaarschuwd.
rootDependency	string	De hoofdafhankelijkheid heeft het onderdeel geïntroduceerd dat wordt gewaarschuwd.
unknown	string
vulnerableDependency	string	Kwetsbare afhankelijkheid. Deze waarde wordt afgeschaft. Gebruik in plaats daarvan Component.

Dismissal

Informatie over een waarschuwingsontzegging

Name	Type	Description
dismissalId	integer	Unieke id voor dit ontslag
dismissalType	DismissalType	Reden voor ontslag
message	string	Informatiebericht dat is gekoppeld aan het ontslag
stateChangedBy	string	Identiteit die de waarschuwing heeft gesloten
stateChangedByIdentity	IdentityRef	Identiteit die de waarschuwing heeft gesloten

DismissalType

Reden voor ontslag

Name	Type	Description
acceptedRisk	string	Ontslag dat aangeeft dat de gebruiker een risico voor de waarschuwing accepteert
agreedToGuidance	string	Ontslag dat aangeeft dat de gebruiker akkoord gaat met het volgen van licentierichtlijnen.
falsePositive	string	Ontslag dat aangeeft dat een waarschuwing een fout-positief is en waarschijnlijk niet wordt opgelost.
fixed	string	Ontslag dat aangeeft dat waarschuwing is opgelost
unknown	string	Type ontslag onbekend

IdentityRef

Name	Type	Description
_links	ReferenceLinks	Dit veld bevat nul of interessantere koppelingen over het grafiekonderwerp. Deze koppelingen kunnen worden aangeroepen om aanvullende relaties te verkrijgen of meer gedetailleerde informatie over dit grafiekonderwerp te verkrijgen.
descriptor	string	De descriptor is de primaire manier om te verwijzen naar het grafiekonderwerp terwijl het systeem wordt uitgevoerd. In dit veld wordt hetzelfde grafiekonderwerp voor zowel Accounts als Organisaties uniek geïdentificeerd.
directoryAlias	string	Afgeschaft - Kan worden opgehaald door een query uit te voeren op de Graph-gebruiker waarnaar wordt verwezen in de 'self'-vermelding van de woordenlijst IdentityRef '_links'.
displayName	string	Dit is de niet-unieke weergavenaam van het grafiekonderwerp. Als u dit veld wilt wijzigen, moet u de waarde ervan in de bronprovider wijzigen.
id	string
imageUrl	string	Afgeschaft - Beschikbaar in de vermelding 'avatar' van de IdentityRef '_links' woordenlijst
inactive	boolean	Afgeschaft - Kan worden opgehaald door een query uit te voeren op de Graph-lidmaatschapsstatus waarnaar wordt verwezen in de vermelding 'membershipState' van de GraphUser-woordenlijst '_links'
isAadIdentity	boolean	Afgeschaft - Kan worden afgeleid van het onderwerptype van de descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Afgeschaft - Kan worden afgeleid van het onderwerptype van de descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Afgeschaft - niet in gebruik in de meeste vooraf bestaande implementaties van ToIdentityRef
uniqueName	string	Afgeschaft - gebruik in plaats daarvan Domain+PrincipalName
url	string	Deze URL is de volledige route naar de bronresource van dit grafiekonderwerp.

License

Licentiegegevens voor afhankelijkheden

Name	Type	Description
name	string	Licentienaam
state	LicenseState	Licentiestatus
url	string	URL voor licentiegegevens

LicenseState

Licentiestatus

Name	Type	Description
harvested	string	Informatie over de licentie is verzameld door ClearlyDefined
notHarvested	string	Informatie over de licentie is niet verzameld door ClearlyDefined
unknown	string	Informatie over de licentie is niet verzameld door ClearlyDefined

LogicalLocation

Name	Type	Description
fullyQualifiedName	string
kind	DependencyKind	Afhankelijkheidstype van deze logische locatie.
license	License	Licentie-informatie voor afhankelijkheid alleen van toepassing wanneer Soort onderdeel is en het alertType van de waarschuwing met deze locatie licentie is

PhysicalLocation

Locatie in het broncodebeheersysteem waar het probleem is gevonden

Name	Type	Description
filePath	string	Pad van het bestand waar het probleem is gevonden
region	Region	Details over de locatie waar het probleem is gevonden, inclusief een fragment
versionControl	VersionControlDetails	Systeemspecifieke informatie over broncodebeheer over de locatie

ReferenceLinks

De klasse die een verzameling REST-verwijzingskoppelingen vertegenwoordigt.

Name	Type	Description
links	object	De leesweergave van de koppelingen. Omdat verwijzingskoppelingen alleen-lezen zijn, willen we ze alleen beschikbaar maken als alleen-lezen.

Region

Name	Type	Description
columnEnd	integer	De kolom waar het codefragment eindigt
columnStart	integer	De kolom waarin het codefragment wordt gestart
lineEnd	integer	Het regelnummer waar het codefragment eindigt
lineStart	integer	Het regelnummer waar het codefragment wordt gestart

RelationMetadata

De metagegevens die aan de waarschuwing moeten worden gekoppeld.

Name	Type	Description
attributes	object	Eventuele extra kenmerken van de metagegevens.
rel	string	Het type metagegevens.
url	string	De URL van de metagegevens.

Rule

De analyseregel die de waarschuwing heeft veroorzaakt.

Name	Type	Description
additionalProperties	object	Aanvullende eigenschappen van deze regel die afhankelijk zijn van het regeltype. Afhankelijkheden kunnen bijvoorbeeld de CVE-id bevatten als deze beschikbaar is.
description	string	Beschrijving van wat deze regel detecteert
friendlyName	string	Regel-id voor tekst zonder opmaak
helpMessage	string	Aanvullende informatie over deze regel
opaqueId	string	Hulpprogrammaspecifieke regel-id
resources	string	Door Markdown opgemaakte lijst met resources voor meer informatie over de regel. In sommige gevallen wordt RuleInfo.AdditionalProperties.advisoryUrls gebruikt.
tags	string[]	Classificatietags voor deze regel

Severity

Ernst van de waarschuwing.

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

State

Deze waarde wordt berekend en geretourneerd door de service. Het is een waarde op basis van de resultaten van alle analyseconfiguraties.

Name	Type	Description
active	string	Er is een waarschuwing gedetecteerd in de code
autoDismissed	string	Het hulpprogramma heeft vastgesteld dat het probleem geen risico meer is
dismissed	string	Waarschuwing is door een gebruiker gesloten
fixed	string	Het probleem wordt niet meer gedetecteerd in de code
unknown	string	Waarschuwing heeft een onbepaalde status

Tool

Een analysehulpprogramma waarmee beveiligingswaarschuwingen kunnen worden gegenereerd

Name	Type	Description
name	string	Naam van het hulpprogramma
rules	Rule[]	De regels die het hulpprogramma definieert

ValidationFingerprint

Name	Type	Description
validationFingerprintHash	string
validationFingerprintJson	string

VersionControlDetails

Informatie over het vinden van bestanden in een broncodebeheersysteem

Name	Type	Description
commitHash	string
itemUrl	string