Советник по безопасности1: различия между версиями
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
Строка 184: | Строка 184: | ||
}</code> | }</code> | ||
* | * | ||
__ССЫЛКА_НА_НОВЫЙ_РАЗДЕЛ__ |
Версия 10:38, 7 июля 2023
API советника по безопасности ИИ
ИИ Advisor Security API перечисляет рекомендации ИИ, связанные с открытыми и скрытыми проблемами безопасности .
Вы можете ограничить вывод, используя разбиение на страницы:
- Укажите количество результатов на странице в параметре запроса pageSize .
- Затем используйте курсор из поля nextPageKey предыдущего ответа в параметре запроса nextPageKey для получения последующих страниц.
Запрос создает application/json
полезную нагрузку.
GET |
|
Аутентификация
Чтобы выполнить этот запрос, вам необходимо разрешение на чтение проблем безопасности ( securityProblems.read
), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | необходимость |
---|---|---|---|---|
managementZoneFilter | string | Чтобы указать зоны управления, используйте одну из опций, перечисленных ниже. Для каждой опции вы можете указать несколько значений, разделенных запятыми. Если указано несколько значений, применяется логика ИЛИ . Все значения чувствительны к регистру и должны быть заключены в кавычки.
Вы можете указать несколько критериев, разделенных запятыми (например, |
запрос | по желанию |
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Если nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | по желанию |
размер страницы | integer | Количество советов по безопасности в одной полезной нагрузке.
Максимально допустимый размер страницы - 500. Если не установлен, используется 5. |
запрос | по желанию |
Ответ
Коды ответов
Код | Описание |
---|---|
200 | Успех |
Тело ответа
- Параметры ответа
AISecurityAdviceList объект
Список советов от советника по безопасности Дэвиса.
Элемент | Тип | Описание |
---|---|---|
totalCount | integer | Общее количество записей в результате. |
размер страницы | integer | Количество записей на странице. |
nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение null на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. Может быть |
advices | AISecurityAdvice[] | -
Может быть |
AISecurityAdvice объект
Совет по безопасности от советника по безопасности Дэвиса.
Элемент | Тип | Описание |
---|---|---|
name | string | Название совета. |
vulnerableComponent | string | Уязвимый компонент, к которому применяется совет. |
technology | string | Технология уязвимого компонента.
Элемент может содержать эти значения |
adviceType | string | Тип совета.
Элемент может содержать эти значения |
critical | string[] | Идентификаторы проблем critical уровня безопасности, вызванных уязвимым компонентом.
|
high | string[] | Идентификаторы проблем high уровня безопасности, вызванных уязвимым компонентом.
|
medium | string[] | Идентификаторы проблем medium уровня безопасности, вызванных уязвимым компонентом.
|
low | string[] | Идентификаторы проблем low уровня безопасности, вызванных уязвимым компонентом.
|
now | string[] | Идентификаторы проблем none уровня безопасности, вызванных уязвимым компонентом.
|
- Модель JSON
Тело ответа
{
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"advices": [
{
"name": "string",
"vulnerableComponent": "string",
"technology": "DOTNET",
"adviceType": "UPGRADE",
"critical": [
"string"
],
"high": [
"string"
],
"medium": [
"string"
],
"low": [
"string"
],
"none": [
"string"
]
}
]
}