Alerts - List

Referência

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

Parâmetros do URI

Name	Em	Necessá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 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 esta versão da api.
continuationToken	query		string	Se houver mais alertas do que podem ser retornados, 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, apenas retorne alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.
criteria.confidenceLevels	query		string[]	Se fornecido, apenas retorne alertas nesses níveis de confiança. Tanto Alto quanto Outros precisam ser especificados para buscar alertas de todos os níveis de confiança. Caso contrário, retorne alertas com alto nível de confiança.
criteria.dependencyName	query		string	Se fornecido, apenas os alertas para essa dependência serão retornados. Caso contrário, retorne alertas para todas as dependências. Em um envio sarif, uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.
criteria.fromDate	query		string date-time	Se fornecido, apenas os alertas de retorno 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 correspondam a esse padrão.
criteria.licenseName	query		string	Se fornecido, apenas os alertas criados para dependência com esta licença são retornados. Caso contrário, retorne alertas para todas as licenças. Em um envio sarif, a licença para uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.properties.license.
criteria.modifiedSince	query		string date-time	Se fornecido, apenas retornará alertas que foram modificados desde essa data. Caso contrário, retorne todos os alertas.
criteria.onlyDefaultBranch	query		boolean	Se true ou não estiver definido, apenas retornará alertas encontrados na ramificação padrão do repositório. Se não houver nenhuma execução concluída na ramificação padrão, a última execução será usada em vez disso, independentemente da ramificação usada para essa execução. Se false, retorne alertas de todas as ramificações. Esta opção será ignorada se ref for fornecida.
criteria.phaseId	query		string uuid	Se fornecido com pipelineName, somente alertas de retorno detetados nesta fase de pipeline Caso contrário, retorne alertas detetados em todas as fases.
criteria.phaseName	query		string	Se fornecido com pipelineName, somente alertas de retorno detetados nesta fase de pipeline Caso contrário, retorne alertas detetados em todas as fases.
criteria.pipelineName	query		string	Se fornecido, apenas os alertas de retorno detetados nesse pipeline. Caso contrário, retorne alertas detetados em todos os pipelines.
criteria.ref	query		string	Se fornecido, inclua apenas alertas para esta ref. Se não for fornecido e OnlyDefaultBranch for true, inclua alertas encontrados na ramificação padrão ou na ramificação de última execução se não houver nenhuma configuração de análise para a ramificação padrão. Caso contrário, inclua alertas de todas as ramificações.
criteria.ruleId	query		string	Se fornecido, apenas retorne alertas para esta regra. Caso contrário, retorne alertas de todas as regras.
criteria.ruleName	query		string	Se fornecido, apenas retorne alertas para esta regra. Caso contrário, retorne alertas para todas as regras.
criteria.severities	query		string[]	Se fornecido, apenas retorne alertas nessas gravidades. Caso contrário, retorne alertas em qualquer servidor.
criteria.states	query		string[]	Se fornecido, apenas alertas de retorno nesses estados. Caso contrário, retorne alertas em qualquer estado.
criteria.toDate	query		string date-time	Se fornecido, apenas os alertas de retorno vistos pela última vez antes dessa data. Caso contrário, retorne todos os alertas.
criteria.toolName	query		string	Se fornecido com toolName, apenas retornará alertas detetados por essa ferramenta. Caso contrário, retorne alertas detetados por todas as ferramentas.
orderBy	query		string	Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" Padrão para "id"
top	query		integer int32	O número máximo de alertas a retornar

Respostas

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

Segurança

oauth2

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: 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

Âmbitos

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

Definições

Name	Description
Alert
AlertType	Tipo de alerta. Por exemplo, segredo, código, etc.
Confidence	Nível de confiança do alerta.
DependencyKind	Tipo de dependência deste local lógico.
Dismissal	Informações sobre um alerta de despedimento
DismissalType	Motivo do despedimento
IdentityRef
License	Informações de licença para dependências
LicenseState	Estado da licença
LogicalLocation
PhysicalLocation	Localização 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 de origem

Alert

Name	Tipo	Description
alertId	integer	Identificador do alerta. É unqiue dentro da organização do Azure DevOps.
alertType	AlertType	Tipo de alerta. Por exemplo, segredo, código, etc.
confidence	Confidence	Nível de confiança do alerta.
dismissal	Dismissal	Contém informações para a rejeição do alerta se este tiver sido indeferido.
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 representa o tempo 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, branch ref.
introducedDate	string	Esse valor é calculado e retornado pelo serviço. Este 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 artefactos.
repositoryUrl	string	URL do repositório onde o alerta foi detetado.
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 só será renderizado como texto e não suporta formatação de marcação. Há um limite máximo de caracteres de 256.
tools	Tool[]	Ferramentas que detetaram esse problema.
truncatedSecret	string	Uma versão truncada/ofuscada do segredo relativo à indicação (se aplicável).
validationFingerprints	ValidationFingerprint[]	ValidaçãoImpressões digitais para a verificação de vivacidade secreta. Somente retornado sob demanda em Get API com o parâmetro Expand definido como ValidationFingerprint (não retornado em List API)

AlertType

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

Name	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 potencial inconformidade 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.

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

DependencyKind

Tipo de dependência deste local lógico.

Name	Tipo	Description
component	string	O componente que está sendo alertado.
rootDependency	string	A dependência raiz introduziu o componente que está sendo alertado.
unknown	string
vulnerableDependency	string	Dependência vulnerável. Depreciando esse valor. Em vez disso, use Componente.

Dismissal

Informações sobre um alerta de despedimento

Name	Tipo	Description
dismissalId	integer	ID exclusivo para este despedimento
dismissalType	DismissalType	Motivo do despedimento
message	string	Mensagem informativa anexada ao despedimento
stateChangedBy	string	Identidade que descartou o alerta
stateChangedByIdentity	IdentityRef	Identidade que descartou o alerta

DismissalType

Motivo do despedimento

Name	Tipo	Description
acceptedRisk	string	Despedimento que indica que o utilizador está a aceitar um risco para o alerta
agreedToGuidance	string	Demissão indicando que o usuário está concordando em seguir as orientações da licença.
falsePositive	string	O despedimento que indica alerta é um falso positivo e provavelmente não será corrigido.
fixed	string	Despedimento indicando que o alerta foi corrigido
unknown	string	Tipo de despedimento desconhecido

IdentityRef

Name	Tipo	Description
_links	ReferenceLinks	Este campo contém zero ou mais links interessantes sobre o assunto do gráfico. Estes links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre este assunto gráfico.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do gráfico enquanto o sistema está em execução. Este campo identificará exclusivamente o mesmo assunto gráfico 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	Este é o nome de exibição não exclusivo do assunto do gráfico. 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 a partir do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido - Pode ser inferido a partir do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido - não está em uso na maioria das implementações preexistentes de ToIdentityRef
uniqueName	string	Preterido - use Domain+PrincipalName em vez disso
url	string	Este url é o caminho completo para o recurso de origem deste assunto gráfico.

License

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

Name	Tipo	Description
name	string	Nome da licença
state	LicenseState	Estado da licença
url	string	Url para informações de licença

LicenseState

Estado da licença

Name	Tipo	Description
harvested	string	As informações da licença foram colhidas pela ClearlyDefined
notHarvested	string	A informação da licença não foi recolhida pela ClearlyDefined
unknown	string	A informação da licença não foi recolhida pela ClearlyDefined

LogicalLocation

Name	Tipo	Description
fullyQualifiedName	string
kind	DependencyKind	Tipo de dependência deste local lógico.
license	License	Informações de licença para dependência Aplicável somente quando Kind é "Componente" e o alertType do alerta com este local é License

PhysicalLocation

Localização no sistema de controle do código-fonte onde o problema foi encontrado

Name	Tipo	Description
filePath	string	Caminho do arquivo onde o problema foi encontrado
region	Region	Detalhes sobre o local onde o problema foi encontrado, incluindo um trecho
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.

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

Region

Name	Tipo	Description
columnEnd	integer	A coluna onde termina o trecho de código
columnStart	integer	A coluna onde o trecho de código começa
lineEnd	integer	O número da linha onde o trecho de código termina
lineStart	integer	O número da linha onde o trecho de código começa

RelationMetadata

Os metadados a serem associados ao alerta.

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

Rule

A regra de análise que causou o alerta.

Name	Tipo	Description
additionalProperties	object	As propriedades adicionais desta regra dependem do tipo de regra. Por exemplo, as regras de dependência podem incluir o ID CVE se estiver disponível.
description	string	Descrição do que esta regra deteta
friendlyName	string	Identificador de regra de texto simples
helpMessage	string	Informações adicionais sobre esta regra
opaqueId	string	Identificador de regra específico da ferramenta
resources	string	Lista de recursos formatada com Markdown para saber mais sobre a Regra. Em alguns casos, RuleInfo.AdditionalProperties.advisoryUrls é usado em vez disso.
tags	string[]	Tags de classificação para esta regra

Severity

Severidade do alerta.

Name	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.

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

Tool

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

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

ValidationFingerprint

Name	Tipo	Description
validationFingerprintHash	string
validationFingerprintJson	string

VersionControlDetails

Informações para localizar arquivos em um sistema de controle de origem

Name	Tipo	Description
commitHash	string
itemUrl	string

Partilhar via