Alerts - Get
Obtenha um alerta.
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}?api-version=7.2-preview.1
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/alert/repositories/{repository}/alerts/{alertId}?ref={ref}&expand={expand}&api-version=7.2-preview.1
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
alert
|
path | True |
integer (int64) |
ID do alerta a ser recuperado |
|
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 |
Nome ou id de um repositório do qual o alerta faz parte |
|
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. |
|
expand
|
query |
Expanda atributos de um alerta secreto. Os valores possíveis são: |
||
|
ref
|
query |
string |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
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 | |
|
Alert |
Tipo do alerta. Por exemplo, segredo, código etc. |
|
Alert |
Dados de validade para um alerta que fará parte das APIs de alertas e da interface do usuário. |
|
Alert |
|
| Confidence |
Nível de confiança do alerta. |
|
Dependency |
Tipo de dependência desse local lógico. |
| Dismissal |
Informações sobre uma demissão de alerta |
|
Dismissal |
Motivo da demissão |
|
Expand |
Expanda atributos de um alerta secreto. Os valores possíveis são: |
|
Identity |
|
| License |
Informações de licença para dependências |
|
License |
Estado da licença |
|
License |
Tipo de licença |
|
Logical |
|
|
Physical |
Local no sistema de controle do código-fonte em que o problema foi encontrado |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
| Region | |
|
Relation |
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 |
|
Validation |
|
|
Validation |
O resultado da validação. |
|
Version |
Informações para localizar arquivos em um sistema de controle do código-fonte |
Alert
| Nome | Tipo | Description |
|---|---|---|
| additionalInformationMessage |
string |
Mensagem de informação adicional para mostrar este alerta. Para ferramentas ASAN, contém detalhes de falha formatados em blocos de código. Para ferramentas de escaneamento de código por IA, contém conteúdo markdown do result.message.markdown. |
| additionalProperties |
object |
Propriedades adicionais desse alerta. |
| alertId |
integer (int64) |
Identificador do alerta. Ele é exclusivo dentro da organização do Azure DevOps. |
| alertType |
Tipo do alerta. Por exemplo, segredo, código etc. |
|
| confidence |
Nível de confiança do alerta. |
|
| dismissal |
Contém informações para a demissão do alerta se o alerta tiver sido ignorado. |
|
| epssPercentile |
number (double) |
Classificação (0-1) de EpssScore em relação a todos os avisos pontuados. Nulo quando nenhum metadados do EPSS estiver disponível para a consultoria. |
| epssScore |
number (double) |
Probabilidade de EPSS (0-1) de que o aviso por trás desse alerta de dependência será explorado nos próximos 30 dias. Nulo quando nenhum metadados do EPSS estiver disponível para a consultoria. |
| 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. |
| hasTrustedSourceOrigin |
boolean |
Valor indica se o alerta vem de um SARIF enviado por uma fonte confiável. |
| introducedDate |
string (date-time) |
Esse valor é computado e retornado pelo serviço. Esse valor representa a primeira vez que a vulnerabilidade foi introduzida. |
| isAutoFixable |
boolean |
O valor indica se Copilot Autofixo pode ser executado no momento no alerta. True quando Copilot Autofixo está disponível para a organização e habilitado no repositório, o alerta é de um tipo qualificado. Nulo quando o valor não tiver sido computado para esse caminho de código. |
| isDevDependency |
boolean |
Valor indica se o alerta foi gerado para uma dependência de desenvolvimento. Verdadeiro indica dependência de desenvolvimento, falso indica dependência em tempo de execução, e nulo indica desconhecido ou não aplicável. |
| 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 |
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 |
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 |
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 |
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. |
|
| 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 512. |
| tools |
Tool[] |
Ferramentas que detectaram esse problema. |
| truncatedSecret |
string |
Uma versão truncada/ofuscada do segredo pertencente ao alerta (se aplicável). |
| validationFingerprints |
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 |
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. |
AlertType
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. |
| aiCode |
O código contém uma fraqueza determinada por análise baseada em IA. |
| malware |
O código usa uma dependência sinalizada como malware pelo Banco de Dados de Consultoria do GitHub. |
AlertValidityInfo
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
| 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
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
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
Informações sobre uma demissão de alerta
| Nome | Tipo | Description |
|---|---|---|
| dismissalId |
integer (int64) |
ID exclusiva para essa demissão |
| dismissalType |
Motivo da demissão |
|
| message |
string |
Mensagem informativa anexada à demissão |
| stateChangedBy |
string (uuid) |
Identidade que descartou o alerta |
| stateChangedByIdentity |
Identidade que descartou o alerta |
DismissalType
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. |
ExpandOption
Expanda atributos de um alerta secreto. Os valores possíveis são: None e ValidationFingerprint. Usa None como padrão. Lembre-se de que, se expand estiver definido como ValidationFingerprint, a resposta poderá conter o segredo em sua forma não criptografada. Tenha cuidado ao usar esses dados.
| Valor | Description |
|---|---|
| none |
Não expande. |
| validationFingerprint |
Retornar validationFingerprints em Alerta. |
IdentityRef
| Nome | Tipo | Description |
|---|---|---|
| _links |
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
Informações de licença para dependências
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
Nome da licença |
| state |
Estado da licença |
|
| type |
Tipo de licença |
|
| url |
string |
URL para informações de licença |
LicenseState
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
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
| Nome | Tipo | Description |
|---|---|---|
| fullyQualifiedName |
string |
|
| kind |
Tipo de dependência desse local lógico. |
|
| 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
Local no sistema de controle do código-fonte em que o problema foi encontrado
| Nome | Tipo | Description |
|---|---|---|
| additionalProperties |
object |
Propriedades adicionais para onde o problema foi encontrado |
| filePath |
string |
Caminho do arquivo em que o problema foi encontrado |
| isValidGitPath |
boolean |
Indica se o caminho é um caminho Git válido que existe no repositório git associado ao alerta. |
| region |
Detalhes sobre o local onde o problema foi encontrado, incluindo um snippet |
|
| versionControl |
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 (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
Os metadados a serem associados ao alerta.
| Nome | Tipo | Description |
|---|---|---|
| attributes |
object |
Quaisquer atributos adicionais dos metadados. |
| properties |
object |
As propriedades 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 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
Gravidade do alerta.
| Valor | Description |
|---|---|
| low | |
| medium | |
| high | |
| critical | |
| note | |
| warning | |
| error | |
| undefined |
State
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 |
| draft |
Alerta está em estado de rascunho e só é visível para identidades na lista privilegiada de alerta de rascunho de Segurança Avançada. Filtrado de todas as respostas de alerta (resultados e contagens) para chamadas não privilegiadas. |
Tool
Uma ferramenta de análise que pode gerar alertas de segurança
| Nome | Tipo | Description |
|---|---|---|
| isDeterministic |
boolean |
Se a ferramenta produz resultados determinísticos. Usado para agrupar ferramentas na interface do filtro de alertas. |
| name |
string |
Nome da ferramenta |
| rules |
Rule[] |
As regras que a ferramenta define |
| toolVersion |
string |
Representação de cadeia de caracteres da versão da ferramenta |
ValidationFingerprint
| Nome | Tipo | Description |
|---|---|---|
| assetFingerprint |
object |
A representação do valor da chave da impressão digital do ativo. |
| c3Id |
string |
Representa o CrossCompanyCorrelatingId para o segredo no ValidationFingerprintJson. |
| normalizedValidationToolVersion |
integer (int32) |
Uma representação de cadeia de caracteres normalizada da versão da ferramenta de validação. |
| 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 |
O resultado da validação. |
ValidationResult
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
Informações para localizar arquivos em um sistema de controle do código-fonte
| Nome | Tipo | Description |
|---|---|---|
| commitHash |
string |
|
| itemUrl |
string |