Alerts - List

Ссылка

Служба:: Advanced Security

Версия API:: 7.2-preview.1

Получение оповещений для репозитория

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

С использованием необязательных параметров:

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}&expand={expand}&continuationToken={continuationToken}&api-version=7.2-preview.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
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.
continuationToken	query		string	Если есть больше оповещений, чем может быть возвращено, маркер продолжения помещается в заголовок x-ms-continuationtoken. Используйте этот маркер здесь, чтобы получить следующую страницу оповещений
criteria.alertIds	query		integer[]	Если указано, возвращаются только оповещения с указанными идентификаторами. В противном случае верните любое оповещение.
criteria.alertType	query		AlertType	Если это указано, возвращаются только оповещения этого типа. В противном случае возвращаются оповещения всех типов.
criteria.confidenceLevels	query		string[]	Если это указано, возвращаются только оповещения на этих уровнях достоверности. Для получения оповещений обо всех уровнях достоверности необходимо указать как высокий, так и другой. В противном случае верните оповещения с высоким уровнем достоверности. Применимо только для оповещений секретов.
criteria.dependencyName	query		string	Если это указано, возвращаются только оповещения для этой зависимости. В противном случае верните оповещения для всех зависимостей. В отправке sarif зависимость (или компонент) указывается в результате. RelatedLocations[].logicalLocation. Неприменимо для оповещений секретов.
criteria.fromDate	query		string date-time	Если это указано, возвращаются только оповещения после этой даты. В противном случае возвращаются все оповещения.
criteria.keywords	query		string	Если это указано, возвращаются только оповещения, заголовки которых соответствуют этому шаблону.
criteria.licenseName	query		string	При условии возвращаются только оповещения, созданные для зависимостей с этой лицензией. В противном случае верните оповещения для всех лицензий. В отправке sarif лицензия на зависимость (или компонент) указывается в результате. RelatedLocations[].logicalLocation.properties.license. Неприменимо для оповещений секретов.
criteria.modifiedSince	query		string date-time	Если это указано, возвращаются только оповещения, которые были изменены с этой даты. В противном случае возвращаются все оповещения.
criteria.onlyDefaultBranch	query		boolean	Если задано значение true или не задано, возвращаются только оповещения, найденные в ветви репозитория по умолчанию. Если в ветви по умолчанию не было завершено выполнение, последнее выполнение используется вместо ветви, используемой для этого запуска. Если значение false, возвращает оповещения из всех ветвей. Этот параметр игнорируется, если указан ссылка. Неприменимо для оповещений секретов.
criteria.phaseId	query		string uuid	Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера. В противном случае возвращаются оповещения, обнаруженные на всех этапах. Неприменимо для оповещений секретов.
criteria.phaseName	query		string	Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера. В противном случае возвращаются оповещения, обнаруженные на всех этапах. Неприменимо для оповещений секретов.
criteria.pipelineName	query		string	Если это указано, возвращаются только оповещения, обнаруженные в этом конвейере. В противном случае возвращаются оповещения, обнаруженные во всех конвейерах. Неприменимо для оповещений секретов.
criteria.ref	query		string	Если это указано, включите только оповещения для этого ссылки. Если не указано и OnlyDefaultBranch имеет значение true, включите только оповещения, найденные в ветви по умолчанию или последней ветви запуска, если для ветви по умолчанию нет конфигурации анализа. В противном случае включите оповещения из всех ветвей. Неприменимо для оповещений секретов.
criteria.ruleId	query		string	Если это указано, возвращаются только оповещения для этого правила. В противном случае возвращаются оповещения обо всех правилах.
criteria.ruleName	query		string	Если это указано, возвращаются только оповещения для этого правила. В противном случае верните оповещения для всех правил.
criteria.severities	query		string[]	Если это указано, возвращаются только оповещения по этим уровням серьезности. В противном случае возврат оповещений при любой серьезности.
criteria.states	query		string[]	Если это указано, возвращаются только оповещения в этих состояниях. В противном случае возвращает оповещения в любом состоянии.
criteria.toDate	query		string date-time	Если это указано, до этой даты возвращаются только оповещения. В противном случае возвращаются все оповещения.
criteria.toolName	query		string	Если задано значение toolName, возвращаются только оповещения, обнаруженные этим средством. В противном случае возвращаются оповещения, обнаруженные всеми средствами.
expand	query		AlertListExpandOption
orderBy	query		string	Должно быть "id" "firstSeen" "lastSeen" "fixedOn" или "серьезность" по умолчанию для "id"
top	query		integer int32	Максимальное количество возвращаемых оповещений

Ответы

Имя	Тип	Описание
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
AlertListExpandOption
AlertType	Тип оповещения. Например, секрет, код и т. д.
AlertValidityInfo	Допустимые данные для оповещения, которые будут частью API оповещений и пользовательского интерфейса.
AlertValidityStatus
Confidence	Уровень достоверности оповещения.
DependencyKind	Тип зависимостей этого логического расположения.
Dismissal	Сведения об увольнении оповещений
DismissalType	Причина увольнения
IdentityRef
License	Сведения о лицензии для зависимостей
LicenseState	Состояние лицензии
LogicalLocation
PhysicalLocation	Расположение в системе управления версиями, в которой обнаружена проблема
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
Region
RelationMetadata	Метаданные, связанные с оповещением.
Rule	Правило анализа, вызвавшее оповещение.
Severity	Серьезность оповещения.
State	Это значение вычисляется и возвращается службой. Это значение, основанное на результатах всех конфигураций анализа.
Tool	Средство анализа, которое может создавать оповещения системы безопасности
ValidationFingerprint
VersionControlDetails	Сведения о поиске файлов в системе управления версиями

Alert

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства этого оповещения.
alertId	integer	Идентификатор оповещения. Она уникальна в организации Azure DevOps.
alertType	AlertType	Тип оповещения. Например, секрет, код и т. д.
confidence	Confidence	Уровень достоверности оповещения.
dismissal	Dismissal	Содержит сведения об увольнении оповещения, если оповещение было отклонено.
firstSeenDate	string	Это значение вычисляется и возвращается службой. Это значение представляет собой первый раз, когда служба видела эту проблему, сообщаемую в экземпляре анализа.
fixedDate	string	Это значение вычисляется и возвращается службой. Если проблема устранена, это значение представляет время, когда служба видела эту проблему, исправленную в экземпляре анализа.
gitRef	string	Ссылка на объект Git, например ссылка на ветвь.
introducedDate	string	Это значение вычисляется и возвращается службой. Это значение представляет собой первый раз, когда была введена уязвимость.
lastSeenDate	string	Это значение вычисляется и возвращается службой. Это значение представляет собой последний раз, когда служба видела эту проблему, сообщаемую в экземпляре анализа.
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	Сведения о допустимости оповещения. В настоящее время это применимо только к секретным оповещениям. В случае секретных оповещений состояние действительности и время вычисляется путем просмотра результатов активности для отпечатков пальцев проверки, связанных с оповещением.

AlertListExpandOption

Имя	Тип	Описание
minimal	string	Возвращает минимальное представление оповещения.
none	string	Нет расширений.

AlertType

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

Имя	Тип	Описание
code	string	Код содержит слабость, определяемую статическим анализом.
dependency	string	Код использует зависимость с известной уязвимостью.
secret	string	Код содержит секрет, который теперь скомпрометирован и должен быть отменен.
unknown	string	Код имеет неуказанный тип уязвимости

AlertValidityInfo

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

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

AlertValidityStatus

Имя	Тип	Описание
active	string
inactive	string
unknown	string

Confidence

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

Имя	Тип	Описание
high	string	Высокий уровень достоверности оповещений
other	string	Другой уровень достоверности для оповещений

DependencyKind

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

Имя	Тип	Описание
component	string	Оповещение компонента.
rootDependency	string	Корневая зависимость представила оповещение компонента.
unknown	string
vulnerableDependency	string	Уязвимая зависимость. Не рекомендуется использовать это значение. Вместо этого используйте компонент.

Dismissal

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

Имя	Тип	Описание
dismissalId	integer	Уникальный идентификатор для этого увольнения
dismissalType	DismissalType	Причина увольнения
message	string	Информационное сообщение, присоединенное к увольнению
stateChangedBy	string	Удостоверение, которое отклонило оповещение
stateChangedByIdentity	IdentityRef	Удостоверение, которое отклонило оповещение

DismissalType

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

Имя	Тип	Описание
acceptedRisk	string	Отклонение, указывающее, что пользователь принимает риск для оповещения
agreedToGuidance	string	Отклонение, указывающее, что пользователь соглашается следовать рекомендациям по лицензии.
falsePositive	string	Отклонение, указывающее, что оповещение является ложным срабатыванием и, скорее всего, не будет исправлено.
fixed	string	Исправлено отклонение, указывающее, что оповещение было исправлено
unknown	string	Неизвестный тип увольнения

IdentityRef

Имя	Тип	Описание
_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

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

Имя	Тип	Описание
name	string	Имя лицензии
state	LicenseState	Состояние лицензии
url	string	Url-адрес для сведений о лицензии

LicenseState

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

Имя	Тип	Описание
harvested	string	Информация о лицензии была собрана ClearlyDefined
notHarvested	string	Информация о лицензии не была собрана ClearlyDefined
unknown	string	Информация о лицензии не была собрана ClearlyDefined

LogicalLocation

Имя	Тип	Описание
fullyQualifiedName	string
kind	DependencyKind	Тип зависимостей этого логического расположения.
license	License	Сведения о лицензии только для зависимостей, применимых только в том случае, если тип "Компонент" и оповещение оповещения с этим расположением — Лицензия

PhysicalLocation

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

Имя	Тип	Описание
filePath	string	Путь к файлу, в котором обнаружена проблема
region	Region	Сведения о расположении, в котором обнаружена проблема, включая фрагмент кода
versionControl	VersionControlDetails	Сведения о расположении системы управления версиями

ReferenceLinks

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

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

Region

Имя	Тип	Описание
columnEnd	integer	Столбец, в котором заканчивается фрагмент кода
columnStart	integer	Столбец, в котором запускается фрагмент кода
lineEnd	integer	Номер строки, в котором заканчивается фрагмент кода
lineStart	integer	Номер строки, в которой начинается фрагмент кода

RelationMetadata

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

Имя	Тип	Описание
attributes	object	Любые дополнительные атрибуты метаданных.
rel	string	Тип метаданных.
url	string	URL-адрес метаданных.

Rule

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

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства этого правила зависят от типа правила. Например, правила зависимостей могут включать идентификатор CVE, если он доступен.
description	string	Описание того, что это правило обнаруживает
friendlyName	string	Идентификатор правила обычного текста
helpMessage	string	Дополнительные сведения об этом правиле
opaqueId	string	Идентификатор правила для конкретного средства
resources	string	Список ресурсов в формате Markdown, чтобы узнать больше о правиле. В некоторых случаях вместо этого используется RuleInfo.AdditionalProperties.advisoryUrls.
tags	string[]	Теги классификации для этого правила

Severity

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

Имя	Тип	Описание
critical	string
error	string
high	string
low	string
medium	string
note	string
undefined	string
warning	string

State

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

Имя	Тип	Описание
active	string	Оповещение обнаружено в коде
autoDismissed	string	Средство определило, что проблема больше не является риском
dismissed	string	Предупреждение было отклонено пользователем
fixed	string	Проблема больше не обнаружена в коде
unknown	string	Оповещение находится в неопределенном состоянии

Tool

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

Имя	Тип	Описание
name	string	Имя средства
rules	Rule[]	Правила, которые определяет средство

ValidationFingerprint

Имя	Тип	Описание
validationFingerprintHash	string
validationFingerprintJson	string
validityLastUpdatedDate	string
validityResult	string

VersionControlDetails

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

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

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