Compartilhar via

Alerts - List

Serviço:
Advanced Security
Versão da API:
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
Com parâmetros opcionais: 
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.hasLinkedWorkItems={criteria.hasLinkedWorkItems}&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}&criteria.validity={criteria.validity}&expand={expand}&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.
Alta e Outra precisam ser especificadas para buscar alertas de todos os níveis de confiança.
Caso contrário, retorne alertas com alto nível de confiança.
Aplicável somente para alertas secretos.
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) é especificada em resultado. RelatedLocations[].logicalLocation.
Não aplicável a alertas secretos.
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.hasLinkedWorkItems
 query

boolean

Se fornecido, filtra alertas com base em se eles têm itens de trabalho vinculados.
Defina como "true" para retornar apenas alertas com itens de trabalho vinculados.
Defina como "false" para retornar apenas alertas sem itens de trabalho vinculados.
Se não for fornecido, retornará todos os alertas independentemente dos itens de trabalho vinculados.
Não aplicável a alertas de verificação de dependência e segredo.
criteria.keywords
 query

string

Se fornecido, retornará apenas alertas cujos títulos correspondem a esse padrão.
criteria.licenseName
 query

string

Se fornecido, somente os alertas criados para dependência com essa licença são retornados.
Caso contrário, retorne alertas para todas as licenças.
Em um envio de sarif, a licença para uma dependência (ou um componente) é especificada em resultado. RelatedLocations[].logicalLocation.properties.license.
Não aplicável a alertas secretos.
criteria.modifiedSince
 query

string (date-time)

Se fornecido, retorne apenas os alertas que foram modificados desde essa data.
Caso contrário, retorne todos os alertas.
criteria.onlyDefaultBranch
 query

boolean

Se for true ou não definido, 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 da ramificação usada para essa execução. Se for falso, retorne alertas de todos os branches.
Essa opção será ignorada se o ref for fornecido.
Não aplicável a alertas secretos.
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.
Não aplicável a alertas secretos.
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.
Não aplicável a alertas secretos.
criteria.pipelineName
 query

string

Se fornecido, retorne apenas os alertas detectados neste pipeline.
Caso contrário, retorne alertas detectados em todos os pipelines.
Não aplicável a alertas secretos.
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 padrão ou no branch de ú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.
Não aplicável a alertas secretos.
criteria.ruleId
 query

string

Se fornecido, retornará apenas alertas para essa regra.
Caso contrário, retorne alertas de todas as regras.
criteria.ruleName
 query

string

Se fornecido, retornará 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 gravidade.
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.
criteria.validity
 query

string[]

Se fornecido, retorne apenas alertas com a validade especificada aqui. Se o status de validade for Desconhecido, busque alertas de todos os resultados de validade.
Aplicável somente para alertas secretos.
Filtrar por status de validade pode fazer com que menos alertas sejam retornados do que o solicitado com o parâmetro TOP.
Devido a esse comportamento, a>ContinuationToken(]] no cabeçalho de resposta deve ser confiada para decidir se outro lote precisa ser buscado.
expand
 query

AlertListExpandOption

orderBy
 query

string

Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severidade" 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

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

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

Definições

Nome Description
Alert
AlertListExpandOption
AlertType

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

Dados de validade para um alerta que fará parte das APIs de alertas e da interface do usuário.
AlertValidityStatus
Confidence

Nível de confiança do alerta.
DependencyKind

Tipo de dependência desse local lógico.
Dismissal

Informações sobre uma demissão de alerta
DismissalType

Motivo da demissão
IdentityRef
License

Informações de licença para dependências
LicenseState

Estado da licença
LicenseType

Tipo de licença
LogicalLocation
PhysicalLocation

Local no sistema de controle do código-fonte em que 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

Gravidade do alerta.
State

Esse valor é computado 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
ValidationResult

O resultado da validação.
VersionControlDetails

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

Alert

Objeto
Nome Tipo Description
additionalProperties

object

Propriedades adicionais desse alerta.
alertId

integer (int64)

Identificador do alerta. Ele é exclusivo dentro da 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 a demissão do alerta se o alerta tiver sido ignorado.
firstSeenDate

string (date-time)

Esse valor é computado 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 (date-time)

Esse valor é computado 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 (date-time)

Esse valor é computado e retornado pelo serviço. Esse valor representa a primeira vez que a vulnerabilidade foi introduzida.
lastSeenDate

string (date-time)

Esse valor é computado 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 é computado 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 é computado 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.
projectId

string (uuid)

Identificador do projeto em que o alerta foi detectado.
relations

RelationMetadata[]

Relações entre alertas e outros artefatos.
repositoryId

string

Identificador do repositório em que o alerta foi detectado.
repositoryUrl

string

URL do repositório em que o alerta foi detectado.
severity

Severity

Gravidade do alerta.
state

State

Esse valor é computado 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 de 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 pertencente ao alerta (se aplicável).
validationFingerprints

ValidationFingerprint[]

ValidationFingerprints para a verificação 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)
validityDetails

AlertValidityInfo

Detalhes de validade de um alerta. Atualmente, isso só é aplicável a alertas secretos. No caso de alertas secretos, o status de validade e a hora são computados examinando os resultados de atividade para impressões digitais de validação associadas a um alerta.

AlertListExpandOption

Enumeração
Valor Description
none

Não expande.
minimal

Retornar uma representação mínima de um alerta.

AlertType

Enumeração

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

Valor Description
unknown

O código tem um tipo de vulnerabilidade não especificado
dependency

O código usa uma dependência com uma vulnerabilidade conhecida.
secret

O código contém um segredo que agora foi comprometido e deve ser revogado.
code

O código contém uma fraqueza determinada pela análise estática.

AlertValidityInfo

Objeto

Dados de validade para um alerta que fará parte das APIs de alertas e da interface do usuário.

Nome Tipo Description
validityLastCheckedDate

string (date-time)

validityStatus

AlertValidityStatus

AlertValidityStatus

Enumeração
Valor Description
none

Quando não há impressões digitais de validação anexadas ao alerta.
unknown

Quando as validações para impressões digitais de validação associadas ao alerta não tiverem sido conclusivas.
active

Quando pelo menos uma impressão digital de validação associada ao alerta é explorável.
inactive

Quando todas as impressões digitais de validação associadas ao alerta não são exploráveis.

Confidence

Enumeração

Nível de confiança do alerta.

Valor Description
high

Alto nível de confiança para alerta
other

Outro nível de confiança para alerta

DependencyKind

Enumeração

Tipo de dependência desse local lógico.

Valor Description
unknown
rootDependency

A dependência raiz introduziu o componente que está sendo alertado.
component

O componente que está sendo alertado.
vulnerableDependency

Dependência vulnerável. Preterindo esse valor. Em vez disso, use o Componente.

Dismissal

Objeto

Informações sobre uma demissão de alerta

Nome Tipo Description
dismissalId

integer (int64)

ID exclusiva para essa demissão
dismissalType

DismissalType

Motivo da demissão
message

string

Mensagem informativa anexada à demissão
stateChangedBy

string (uuid)

Identidade que descartou o alerta
stateChangedByIdentity

IdentityRef

Identidade que descartou o alerta

DismissalType

Enumeração

Motivo da demissão

Valor Description
unknown

Tipo de demissão desconhecido
fixed

A demissão indicando que o alerta foi corrigido
acceptedRisk

Demissão indicando que o usuário está aceitando um risco para o alerta
falsePositive

A demissão indicando que o alerta é um falso positivo e provavelmente não será corrigido.
agreedToGuidance

Demissão indicando que o usuário está concordando em seguir as diretrizes de licença.
toolUpgrade

A demissão indica que a ferramenta de detecção de back-end foi atualizada e o alerta não é detectado pela nova versão da ferramenta.
notDistributed

A demissão indicando que a dependência afetada não é distribuída aos usuários finais.

IdentityRef

Objeto
Nome Tipo Description
_links

ReferenceLinks

Este 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 de grafo em 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

Esse é 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" do 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 adiado 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 pré-existentes de ToIdentityRef
uniqueName

string

Preterido – use Domain+PrincipalName em vez disso
url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

License

Objeto

Informações de licença para dependências

Nome Tipo Description
name

string

Nome da licença
state

LicenseState

Estado da licença
type

LicenseType

Tipo de licença
url

string

URL para informações de licença

LicenseState

Enumeração

Estado da licença

Valor Description
unknown

As informações da licença não foram coletadas pelo ClearlyDefined
notHarvested

As informações da licença não foram coletadas pelo ClearlyDefined
harvested

As informações da licença foram coletadas pelo ClearlyDefined

LicenseType

Enumeração

Tipo de licença

Valor Description
unknown

O tipo de licença é desconhecido ou não especificado.
permissive

Uma licença permissiva permite que o software seja usado livremente, modificado e distribuído com restrições mínimas. Exemplos: MIT, Apache 2.0.
weakCopyleft

Uma licença copyleft fraca requer que as modificações no software sejam compartilhadas com a mesma licença, mas não impõe restrições a trabalhos maiores que incluem o software. Exemplos: LGPL.
strongCopyleft

Uma licença copyleft forte requer que quaisquer trabalhos derivados ou trabalhos maiores que incluam o software também devem ser distribuídos sob a mesma licença. Exemplos: GPL.
networkCopyleft

Uma licença copyleft de rede estende o requisito copyleft para o software que é acessado em uma rede, exigindo que o código-fonte seja disponibilizado. Exemplos: AGPL.
other

Uma licença que não se encaixa nas categorias padrão ou é definida sob medida. No CG, indica uma licença comercial.
noAssertion

Nenhuma declaração é feita sobre o tipo de licença, deixando-o não especificado.

LogicalLocation

Objeto
Nome Tipo Description
fullyQualifiedName

string

kind

DependencyKind

Tipo de dependência desse local lógico.
license

License

Informações de licença para Dependência aplicáveis somente quando Kind é "Component" e o alertType do alerta com esse local é Licença

PhysicalLocation

Objeto

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

Nome Tipo Description
filePath

string

Caminho do arquivo em que o problema foi encontrado
region

Region

Detalhes sobre o local onde o problema foi encontrado, incluindo um snippet
versionControl

VersionControlDetails

Informações específicas do sistema de controle do código-fonte sobre o local
Objeto

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

Objeto
Nome Tipo Description
columnEnd

integer (int32)

A coluna em que o snippet de código termina
columnStart

integer (int32)

A coluna em que o snippet de código é iniciado
lineEnd

integer (int32)

O número de linha em que o snippet de código termina
lineStart

integer (int32)

O número de linha em que o snippet de código é iniciado

RelationMetadata

Objeto

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

Objeto

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 da 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 formatados por Markdown para saber mais sobre a Regra. Em alguns casos, RuleInfo.AdditionalProperties.advisoryUrls é usado em vez disso.
tags

string[]

Marcas de classificação para essa regra

Severity

Enumeração

Gravidade do alerta.

Valor Description
low
medium
high
critical
note
warning
error
undefined

State

Enumeração

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

Valor Description
unknown

O alerta está em um estado indeterminado
active

O alerta foi detectado no código
dismissed

O alerta foi ignorado por um usuário
fixed

O problema não é mais detectado no código
autoDismissed

A ferramenta determinou que o problema não é mais um risco

Tool

Objeto

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

Objeto
Nome Tipo Description
assetFingerprint

object

A representação do valor da chave da impressão digital do ativo.
validationFingerprintHash

string

O hash associado ao segredo.
validationFingerprintJson

string

A representação JSON do segredo. Lembre-se de que esse campo pode conter o segredo em sua forma não criptografada. Tenha cuidado ao usar este campo.
validityLastUpdatedDate

string (date-time)

A data em que a validade foi atualizada pela última vez.
validityResult

ValidationResult

O resultado da validação.

ValidationResult

Enumeração

O resultado da validação.

Valor Description
none

Valor padrão, nenhuma informação sobre o segredo pode ser inferida a partir disso.
exploitable

Representa um segredo que pode ser usado para se conectar a um recurso.
notExploitable

Representa um segredo que não pode ser usado para se conectar a um recurso.
inconclusive

Representa um segredo em que nenhuma determinação pode ser feita sobre sua exploração.
validationNotSupported

Representa um segredo em que não é possível validar, por exemplo, o validador dinâmico ausente.
transientError

Representa um segredo em que o processo de validação falhou devido a um erro transitório, por exemplo, problema de rede. Esse resultado indica que o processo de validação deve ser repetido.

VersionControlDetails

Objeto

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

Nome Tipo Description
commitHash

string

itemUrl

string