Alerts - List

Referência

Service:: Advanced Security

API Version:: 7.2-preview.1

Obter alertas para um repositório

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

With optional 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.modifiedSince={criteria.modifiedSince}&criteria.onlyDefaultBranchAlerts={criteria.onlyDefaultBranchAlerts}&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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
repository	path	True	string	O nome ou a ID do repositório
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.2-preview.1' para usar essa versão da api.
continuationToken	query		string	Se houver mais alertas do que pode ser retornado, um token de continuação será colocado no cabeçalho "x-ms-continuationtoken". Use esse token aqui para obter a próxima página de alertas
criteria.alertIds	query		integer[]	Se fornecido, retorne apenas alertas com as IDs especificadas. Caso contrário, retorne qualquer alerta.
criteria.alertType	query		AlertType	Se fornecido, retornará apenas alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.
criteria.confidenceLevels	query		string[]	Se fornecido, retornará apenas alertas nesses níveis de confiança. Caso contrário, retorne alertas em qualquer nível de confiança.
criteria.dependencyName	query		string	Se fornecido, somente os alertas para essa dependência serão retornados. Caso contrário, retorne alertas para todas as dependências. Em um envio de sarif, uma dependência (ou um componente vulnerável) é especificada em resultado. RelatedLocations[].logicalLocation.
criteria.fromDate	query		string date-time	Se fornecido, retorne apenas os alertas vistos pela última vez após essa data. Caso contrário, retorne todos os alertas.
criteria.keywords	query		string	Se fornecido, retorne apenas alertas cujos títulos correspondem a esse padrão.
criteria.modifiedSince	query		string date-time	Se fornecido, retorne apenas os alertas que foram modificados desde esta data. Caso contrário, retorne todos os alertas.
criteria.onlyDefaultBranchAlerts	query		boolean	Se for true, retorne apenas os alertas encontrados no branch padrão do repositório. Se não houver nenhuma execução concluída no branch padrão, a última execução será usada, independentemente do branch usado para essa execução. Essa opção será ignorada se ref for fornecido.
criteria.phaseId	query		string uuid	Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline Caso contrário, retorne alertas detectados em todas as fases.
criteria.phaseName	query		string	Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline Caso contrário, retorne alertas detectados em todas as fases.
criteria.pipelineName	query		string	Se fornecido, retorne apenas os alertas detectados neste pipeline. Caso contrário, retorne alertas detectados em todos os pipelines.
criteria.ref	query		string	Se fornecido, inclua apenas alertas para esse ref. Se não for fornecido e OnlyDefaultBranch for true, inclua apenas os alertas encontrados no branch branch padrão ou na última execução se não houver nenhuma configuração de análise para o branch padrão. Caso contrário, inclua alertas de todos os branches.
criteria.ruleId	query		string	Se fornecido, retorne apenas alertas para essa regra. Caso contrário, retorne alertas de todas as regras.
criteria.ruleName	query		string	Se fornecido, retorne apenas alertas para essa regra. Caso contrário, retorne alertas para todas as regras.
criteria.severities	query		string[]	Se fornecido, retornará apenas alertas nessas severidades. Caso contrário, retorne alertas em qualquer serverity.
criteria.states	query		string[]	Se fornecido, retornará apenas alertas nesses estados. Caso contrário, retorne alertas em qualquer estado.
criteria.toDate	query		string date-time	Se fornecido, retorne apenas os alertas vistos pela última vez antes dessa data. Caso contrário, retorne todos os alertas.
criteria.toolName	query		string	Se fornecido com toolName, retorne apenas os alertas detectados por essa ferramenta. Caso contrário, retorne alertas detectados por todas as ferramentas.
orderBy	query		string	Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" Padrões para "id"
top	query		integer int32	O número máximo de alertas a serem retornados

Respostas

Nome	Tipo	Description
200 OK	Alert[]	operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization 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

Scopes

Nome	Description
vso.advsec	Concede a capacidade de ler alertas, instâncias de resultado, instâncias de resultado de análise

Definições

Nome	Description
Alert
AlertType	Tipo do alerta. Por exemplo, segredo, código etc.
Confidence	Nível de confiança do alerta.
Dismissal	Informações sobre uma demissão de alerta
DismissalType	Motivo da demissão
IdentityRef
LogicalLocation
PhysicalLocation	Local no sistema de controle do código-fonte onde o problema foi encontrado
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
Region
RelationMetadata	Os metadados a serem associados ao alerta.
Rule	A regra de análise que causou o alerta.
Severity	Severidade do alerta.
State	Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise.
Tool	Uma ferramenta de Análise que pode gerar alertas de segurança
ValidationFingerprint
VersionControlDetails	Informações para localizar arquivos em um sistema de controle do código-fonte

Alert

Nome	Tipo	Description
alertId	integer	Identificador do alerta. Ele não é usado na organização do Azure DevOps.
alertType	AlertType	Tipo do alerta. Por exemplo, segredo, código etc.
confidence	Confidence	Nível de confiança do alerta.
dismissal	Dismissal	Contém informações para o descarte do alerta se o alerta tiver sido ignorado.
firstSeenDate	string	Esse valor é calculado e retornado pelo serviço. Esse valor representa a primeira vez que o serviço vê esse problema relatado em uma instância de análise.
fixedDate	string	Esse valor é calculado e retornado pelo serviço. Se o problema for corrigido, esse valor representará a hora em que o serviço viu esse problema corrigido em uma instância de análise.
gitRef	string	Referência a um objeto git, por exemplo, ref branch.
introducedDate	string	Esse valor é calculado e retornado pelo serviço. Esse valor representa a primeira vez que a vulnerabilidade foi introduzida.
lastSeenDate	string	Esse valor é calculado e retornado pelo serviço. Esse valor representa a última vez que o serviço viu esse problema relatado em uma instância de análise.
logicalLocations	LogicalLocation[]	Locais lógicos para o alerta. Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local lógico é um componente.
physicalLocations	PhysicalLocation[]	Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise. Um exemplo de um local físico é um local de arquivo.
relations	RelationMetadata[]	Relações entre alertas e outros artefatos.
repositoryUrl	string	URL do repositório em que o alerta foi detectado.
severity	Severity	Severidade do alerta.
state	State	Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise.
title	string	O título será renderizado apenas como texto e não dará suporte à formatação markdown. Há um limite máximo de caracteres de 256.
tools	Tool[]	Ferramentas que detectaram esse problema.
truncatedSecret	string	Uma versão truncada/ofuscada do segredo referente ao alerta (se aplicável).
validationFingerprints	ValidationFingerprint[]	ValidationFingerprints para a marcar de vida secreta. Retornado somente sob demanda na API Get com o parâmetro Expand definido como ValidationFingerprint (não retornado na API de Lista)

AlertType

Tipo do alerta. Por exemplo, segredo, código etc.

Nome	Tipo	Description
code	string	O código contém uma fraqueza determinada pela análise estática.
dependency	string	O código usa uma dependência com uma vulnerabilidade conhecida.
license	string	O código usa uma dependência com possível incompatibilidade de licença.
secret	string	O código contém um segredo que agora foi comprometido e deve ser revogado.
unknown	string	O código tem um tipo de vulnerabilidade não especificado

Confidence

Nível de confiança do alerta.

Nome	Tipo	Description
high	string	Alto nível de confiança para alerta
other	string	Outro nível de confiança para alerta

Dismissal

Informações sobre uma demissão de alerta

Nome	Tipo	Description
dismissalId	integer	ID exclusiva para esta demissão
dismissalType	DismissalType	Motivo da demissão
message	string	Mensagem informativa anexada à demissão
stateChangedBy	string	Identidade que descartou o alerta
stateChangedByIdentity	IdentityRef	Identidade que descartou o alerta

DismissalType

Motivo da demissão

Nome	Tipo	Description
acceptedRisk	string	Demissão indicando que o usuário está aceitando um risco para o alerta
falsePositive	string	Demissão indicando que o alerta é um falso positivo e provavelmente não será corrigido.
fixed	string	Demissão indicando que o alerta foi corrigido
unknown	string	Tipo de demissão desconhecido

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
displayName	string	Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido - Disponível na entrada "avatar" do dicionário "_links" IdentityRef
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistidas de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

LogicalLocation

Nome	Tipo	Description
fullyQualifiedName	string
kind	string	Valores possíveis: "unknown" "rootDependency" e "vulnerableDependency"

PhysicalLocation

Local no sistema de controle do código-fonte onde o problema foi encontrado

Nome	Tipo	Description
filePath	string	Caminho do arquivo em que o problema foi encontrado
region	Region	Detalhes sobre o local em que o problema foi encontrado, incluindo um snippet
versionControl	VersionControlDetails	Informações específicas do sistema de controle do código-fonte sobre o local

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Region

Nome	Tipo	Description
columnEnd	integer	A coluna em que o snippet de código termina
columnStart	integer	A coluna em que o snippet de código é iniciado
lineEnd	integer	O número de linha em que o snippet de código termina
lineStart	integer	O número de linha em que o snippet de código é iniciado

RelationMetadata

Os metadados a serem associados ao alerta.

Nome	Tipo	Description
attributes	object	Quaisquer atributos adicionais dos metadados.
rel	string	O tipo dos metadados.
url	string	A URL dos metadados.

Rule

A regra de análise que causou o alerta.

Nome	Tipo	Description
additionalProperties	object	Propriedades adicionais dessa regra dependentes do tipo de regra. Por exemplo, as regras de dependência podem incluir a ID CVE se ela estiver disponível.
description	string	Descrição do que essa regra detecta
friendlyName	string	Identificador de regra de texto sem formatação
helpMessage	string	Informações adicionais sobre essa regra
opaqueId	string	Identificador de regra específico da ferramenta
resources	string	Lista de recursos formatada em Markdown para saber mais sobre a Regra. Em alguns casos, RuleInfo.AdditionalProperties.advisoryUrls é usado.
tags	string[]	Marcas de classificação para essa regra

Severity

Severidade do alerta.

Nome	Tipo	Description
critical	string
error	string
high	string
low	string
medium	string
note	string
undefined	string
warning	string

State

Esse valor é calculado e retornado pelo serviço. É um valor baseado nos resultados de todas as configurações de análise.

Nome	Tipo	Description
active	string	O alerta foi detectado no código
autoDismissed	string	A ferramenta determinou que o problema não é mais um risco
dismissed	string	O alerta foi ignorado por um usuário
fixed	string	O problema não é mais detectado no código
unknown	string	O alerta está em um estado indeterminado

Tool

Uma ferramenta de Análise que pode gerar alertas de segurança

Nome	Tipo	Description
name	string	Nome da ferramenta
rules	Rule[]	As regras que a ferramenta define

ValidationFingerprint

Nome	Tipo	Description
validationFingerprintHash	string
validationFingerprintJson	string

VersionControlDetails

Informações para localizar arquivos em um sistema de controle do código-fonte

Nome	Tipo	Description
commitHash	string
itemUrl	string

Compartilhar via