Поделиться через

Alerts - Get

Служба:
Advanced Security
Версия API:
7.2-preview.1

Получите оповещение.

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

Параметры URI

Имя В Обязательно Тип Описание
alertId
 path True

integer (int64)

Идентификатор генерации оповещений для получения
organization
 path True

string

Имя организации Azure DevOps.
project
 path True

string

Идентификатор проекта или имя проекта
repository
 path True

string

Имя или идентификатор репозитория, который оповещение является частью
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение 7.2-preview.1.
expand
 query

ExpandOption

Разверните атрибуты оповещений. Возможные параметры : {ValidationFingerprint, None}
ref
 query

string

Ответы

Имя Тип Описание
200 OK

Alert

успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя Описание
vso.advsec Предоставляет возможность чтения оповещений, экземпляров результатов, экземпляров результатов анализа

Определения

Имя Описание
Alert
AlertType

Тип оповещения. Например, секрет, код и т. д.
AlertValidityInfo

Допустимые данные для оповещения, которые будут частью API оповещений и пользовательского интерфейса.
AlertValidityStatus
Confidence

Уровень достоверности оповещения.
DependencyKind

Тип зависимостей этого логического расположения.
Dismissal

Сведения об увольнении оповещений
DismissalType

Причина увольнения
ExpandOption

Разверните атрибуты оповещений. Возможные параметры : {ValidationFingerprint, None}
IdentityRef
License

Сведения о лицензии для зависимостей
LicenseState

Состояние лицензии
LicenseType

Тип лицензии
LogicalLocation
PhysicalLocation

Расположение в системе управления версиями, в которой обнаружена проблема
ReferenceLinks

Класс, представляющий коллекцию ссылок REST.
Region
RelationMetadata

Метаданные, связанные с оповещением.
Rule

Правило анализа, вызвавшее оповещение.
Severity

Серьезность оповещения.
State

Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа.
Tool

Средство анализа, которое может создавать оповещения системы безопасности
ValidationFingerprint
ValidationResult

Результат проверки.
VersionControlDetails

Сведения о поиске файлов в системе управления версиями

Alert

Object
Имя Тип Описание
additionalProperties

object

Дополнительные свойства этого оповещения.
alertId

integer (int64)

Идентификатор оповещения. Она уникальна в организации Azure DevOps.
alertType

AlertType

Тип оповещения. Например, секрет, код и т. д.
confidence

Confidence

Уровень достоверности оповещения.
dismissal

Dismissal

Содержит сведения об увольнении оповещения, если оповещение было отклонено.
firstSeenDate

string (date-time)

Это значение вычисляется и возвращается службой. Это значение представляет собой первый раз, когда служба видела эту проблему, сообщаемую в экземпляре анализа.
fixedDate

string (date-time)

Это значение вычисляется и возвращается службой. Если проблема устранена, это значение представляет время, когда служба видела эту проблему, исправленную в экземпляре анализа.
gitRef

string

Ссылка на объект Git, например ссылка на ветвь.
introducedDate

string (date-time)

Это значение вычисляется и возвращается службой. Это значение представляет собой первый раз, когда была введена уязвимость.
lastSeenDate

string (date-time)

Это значение вычисляется и возвращается службой. Это значение представляет собой последний раз, когда служба видела эту проблему, сообщаемую в экземпляре анализа.
logicalLocations

LogicalLocation[]

Логические расположения для оповещения. Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа. Примером логического расположения является компонент.
physicalLocations

PhysicalLocation[]

Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа. Примером физического расположения является расположение файла.
relations

RelationMetadata[]

Отношения между оповещениями и другими артефактами.
repositoryUrl

string

URL-адрес репозитория, в котором обнаружено оповещение.
severity

Severity

Серьезность оповещения.
state

State

Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа.
title

string

Заголовок будет отображаться только как текст и не поддерживает форматирование markdown. Существует максимальное ограничение в 256 символов.
tools

Tool[]

Средства, которые обнаружили эту проблему.
truncatedSecret

string

Усеченная или запутаемая версия секрета, относящаяся к оповещению (если применимо).
validationFingerprints

ValidationFingerprint[]

ValidationFingerprints для проверки активности секрета. Возвращается только по запросу в Get API с параметром Expand, который должен быть ValidateFingerprint (не возвращен в API списка)
validityDetails

AlertValidityInfo

Сведения о допустимости оповещения. В настоящее время это применимо только к секретным оповещениям. В случае секретных оповещений состояние действительности и время вычисляется путем просмотра результатов активности для отпечатков пальцев проверки, связанных с оповещением.

AlertType

Перечисление

Тип оповещения. Например, секрет, код и т. д.

Значение Описание
code

Код содержит слабость, определяемую статическим анализом.
dependency

Код использует зависимость с известной уязвимостью.
secret

Код содержит секрет, который теперь скомпрометирован и должен быть отменен.
unknown

Код имеет неуказанный тип уязвимости

AlertValidityInfo

Object

Допустимые данные для оповещения, которые будут частью API оповещений и пользовательского интерфейса.

Имя Тип Описание
validityLastCheckedDate

string (date-time)

validityStatus

AlertValidityStatus

AlertValidityStatus

Перечисление
Значение Описание
active

При обнаружении одного отпечатка пальца проверки, связанного с оповещением, можно использовать.
inactive

Если все отпечатки пальцев проверки, связанные с оповещением, недоступны для использования.
none

Если к оповещению нет отпечатков пальцев проверки.
unknown

Если проверки для отпечатков пальцев проверки, связанных с оповещением, не были исчерпывающими.

Confidence

Перечисление

Уровень достоверности оповещения.

Значение Описание
high

Высокий уровень достоверности оповещений
other

Другой уровень достоверности для оповещений

DependencyKind

Перечисление

Тип зависимостей этого логического расположения.

Значение Описание
component

Оповещение компонента.
rootDependency

Корневая зависимость представила оповещение компонента.
unknown
vulnerableDependency

Уязвимая зависимость. Не рекомендуется использовать это значение. Вместо этого используйте компонент.

Dismissal

Object

Сведения об увольнении оповещений

Имя Тип Описание
dismissalId

integer (int64)

Уникальный идентификатор для этого увольнения
dismissalType

DismissalType

Причина увольнения
message

string

Информационное сообщение, присоединенное к увольнению
stateChangedBy

string (uuid)

Удостоверение, которое отклонило оповещение
stateChangedByIdentity

IdentityRef

Удостоверение, которое отклонило оповещение

DismissalType

Перечисление

Причина увольнения

Значение Описание
acceptedRisk

Отклонение, указывающее, что пользователь принимает риск для оповещения
agreedToGuidance

Отклонение, указывающее, что пользователь соглашается следовать рекомендациям по лицензии.
falsePositive

Отклонение, указывающее, что оповещение является ложным срабатыванием и, скорее всего, не будет исправлено.
fixed

Исправлено отклонение, указывающее, что оповещение было исправлено
notDistributed

Увольнение, указывающее, что затронутая зависимость не распространяется для конечных пользователей.
toolUpgrade

Отклонение, указывающее, что средство обнаружения серверной части обновлено, и оповещение не обнаруживается новой версией средства.
unknown

Неизвестный тип увольнения

ExpandOption

Перечисление

Разверните атрибуты оповещений. Возможные параметры : {ValidationFingerprint, None}

Значение Описание
none

Нет расширений.
validationFingerprint

Возврат проверкиFingerprints в оповещении.

IdentityRef

Object
Имя Тип Описание
_links

ReferenceLinks

Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor

string

Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias

string

Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь Graph в записи "self" словаря IdentityRef "_links"
displayName

string

Это не уникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в исходном поставщике.
id

string

imageUrl

string

Не рекомендуется . Доступно в записи "аватар" словаря IdentityRef "_links"
inactive

boolean

Нерекомендуемый — можно получить, запросив состояние членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links"
isAadIdentity

boolean

Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType)
isContainer

boolean

Нерекомендуемый — можно выводить из типа субъекта дескриптора (descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Не рекомендуется — не используется в большинстве стандартных реализаций ToIdentityRef
uniqueName

string

Не рекомендуется — вместо этого используйте domain+PrincipalName
url

string

Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

License

Object

Сведения о лицензии для зависимостей

Имя Тип Описание
name

string

Имя лицензии
state

LicenseState

Состояние лицензии
type

LicenseType

Тип лицензии
url

string

Url-адрес для сведений о лицензии

LicenseState

Перечисление

Состояние лицензии

Значение Описание
harvested

Информация о лицензии была собрана ClearlyDefined
notHarvested

Информация о лицензии не была собрана ClearlyDefined
unknown

Информация о лицензии не была собрана ClearlyDefined

LicenseType

Перечисление

Тип лицензии

Значение Описание
networkCopyleft

Лицензия на копирование сети расширяет требование копирования к программному обеспечению, доступ к которому осуществляется через сеть, требуя, чтобы исходный код был доступен. Примеры: AGPL.
noAssertion

Утверждение о типе лицензии не производится, оставляя его неуверенным.
other

Лицензия, которая не соответствует стандартным категориям или настраивается. В CG это означает коммерческую лицензию.
permissive

Разрешительная лицензия позволяет свободно использовать, изменять и распространять программное обеспечение с минимальными ограничениями. Примеры: MIT, Apache 2.0.
strongCopyleft

Для строгой лицензии copyleft требуется, чтобы любые производные работы или более крупные работы, включающие программное обеспечение, также должны распространяться по той же лицензии. Примеры: GPL.
unknown

Тип лицензии не указан.
weakCopyleft

Слабая лицензия copyleft требует изменения программного обеспечения для совместного использования в рамках той же лицензии, но не накладывает ограничения на более крупные работы, включающие программное обеспечение. Примеры: LGPL.

LogicalLocation

Object
Имя Тип Описание
fullyQualifiedName

string

kind

DependencyKind

Тип зависимостей этого логического расположения.
license

License

Сведения о лицензии только для зависимостей, применимых только в том случае, если тип "Компонент" и оповещение оповещения с этим расположением — Лицензия

PhysicalLocation

Object

Расположение в системе управления версиями, в которой обнаружена проблема

Имя Тип Описание
filePath

string

Путь к файлу, в котором обнаружена проблема
region

Region

Сведения о расположении, в котором обнаружена проблема, включая фрагмент кода
versionControl

VersionControlDetails

Сведения о расположении системы управления версиями
Object

Класс, представляющий коллекцию ссылок REST.

Имя Тип Описание
links

object

Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

Region

Object
Имя Тип Описание
columnEnd

integer (int32)

Столбец, в котором заканчивается фрагмент кода
columnStart

integer (int32)

Столбец, в котором запускается фрагмент кода
lineEnd

integer (int32)

Номер строки, в котором заканчивается фрагмент кода
lineStart

integer (int32)

Номер строки, в которой начинается фрагмент кода

RelationMetadata

Object

Метаданные, связанные с оповещением.

Имя Тип Описание
attributes

object

Любые дополнительные атрибуты метаданных.
rel

string

Тип метаданных.
url

string

URL-адрес метаданных.

Rule

Object

Правило анализа, вызвавшее оповещение.

Имя Тип Описание
additionalProperties

object

Дополнительные свойства этого правила зависят от типа правила. Например, правила зависимостей могут включать идентификатор CVE, если он доступен.
description

string

Описание того, что это правило обнаруживает
friendlyName

string

Идентификатор правила обычного текста
helpMessage

string

Дополнительные сведения об этом правиле
opaqueId

string

Идентификатор правила для конкретного средства
resources

string

Список ресурсов в формате Markdown, чтобы узнать больше о правиле. В некоторых случаях вместо этого используется RuleInfo.AdditionalProperties.advisoryUrls.
tags

string[]

Теги классификации для этого правила

Severity

Перечисление

Серьезность оповещения.

Значение Описание
critical
error
high
low
medium
note
undefined
warning

State

Перечисление

Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа.

Значение Описание
active

Оповещение обнаружено в коде
autoDismissed

Средство определило, что проблема больше не является риском
dismissed

Предупреждение было отклонено пользователем
fixed

Проблема больше не обнаружена в коде
unknown

Оповещение находится в неопределенном состоянии

Tool

Object

Средство анализа, которое может создавать оповещения системы безопасности

Имя Тип Описание
name

string

Имя средства
rules

Rule[]

Правила, которые определяет средство

ValidationFingerprint

Object
Имя Тип Описание
validationFingerprintHash

string

Хэш, связанный с секретом.
validationFingerprintJson

string

Представление секрета в формате JSON.
validityLastUpdatedDate

string (date-time)

Дата последнего обновления срока действия.
validityResult

ValidationResult

Результат проверки.

ValidationResult

Перечисление

Результат проверки.

Значение Описание
exploitable

Представляет секрет, который можно использовать для подключения к ресурсу.
inconclusive

Представляет секрет, в котором не может быть сделано никакое определение о его эксплуатируемости.
none

Значение по умолчанию, сведения о секрете не могут быть выведены из этого значения.
notExploitable

Представляет секрет, который не может использоваться для подключения к ресурсу.

VersionControlDetails

Object

Сведения о поиске файлов в системе управления версиями

Имя Тип Описание
commitHash

string

itemUrl

string