Alerts - List

Referensi

Service:: Advanced Security

API Version:: 7.2-preview.1

Mendapatkan pemberitahuan untuk repositori

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

With optional parameters:

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.modifiedSince={criteria.modifiedSince}&criteria.onlyDefaultBranchAlerts={criteria.onlyDefaultBranchAlerts}&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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path	True	string	ID proyek atau nama proyek
repository	path	True	string	Nama atau ID repositori
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.2-preview.1' untuk menggunakan versi api ini.
continuationToken	query		string	Jika ada lebih banyak pemberitahuan daripada yang dapat dikembalikan, token kelanjutan ditempatkan di header "x-ms-continuationtoken". Gunakan token tersebut di sini untuk mendapatkan halaman pemberitahuan berikutnya
criteria.alertIds	query		integer[]	Jika disediakan, hanya kembalikan pemberitahuan dengan id yang ditentukan. Jika tidak, kembalikan pemberitahuan apa pun.
criteria.alertType	query		AlertType	Jika disediakan, hanya kembalikan pemberitahuan jenis ini. Jika tidak, kembalikan pemberitahuan dari semua jenis.
criteria.confidenceLevels	query		string[]	Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keyakinan ini. Jika tidak, kembalikan pemberitahuan pada tingkat keyakinan apa pun.
criteria.dependencyName	query		string	Jika disediakan, hanya pemberitahuan untuk dependensi ini yang dikembalikan. Jika tidak, kembalikan pemberitahuan untuk semua dependensi. Dalam pengajuan sarif, dependensi (atau komponen yang rentan) ditentukan hasilnya. RelatedLocations[].logicalLocation.
criteria.fromDate	query		string date-time	Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat setelah tanggal ini. Jika tidak, kembalikan semua pemberitahuan.
criteria.keywords	query		string	Jika disediakan, hanya kembalikan pemberitahuan yang judulnya cocok dengan pola ini.
criteria.modifiedSince	query		string date-time	Jika disediakan, hanya kembalikan pemberitahuan yang dimodifikasi sejak tanggal ini. Jika tidak, kembalikan semua pemberitahuan.
criteria.onlyDefaultBranchAlerts	query		boolean	Jika true, hanya kembalikan pemberitahuan yang ditemukan di cabang default repositori. Jika belum ada eksekusi yang diselesaikan pada cabang default, eksekusi terakhir digunakan sebagai gantinya terlepas dari cabang yang digunakan untuk eksekusi tersebut. Opsi ini diabaikan jika ref disediakan.
criteria.phaseId	query		string uuid	Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase.
criteria.phaseName	query		string	Jika disediakan dengan pipelineName, hanya kembalikan pemberitahuan yang terdeteksi dalam fase alur ini Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua fase.
criteria.pipelineName	query		string	Jika disediakan, hanya kembalikan pemberitahuan yang terdeteksi dalam alur ini. Jika tidak, kembalikan pemberitahuan yang terdeteksi di semua alur.
criteria.ref	query		string	Jika disediakan, hanya sertakan pemberitahuan untuk ref ini. Jika tidak disediakan dan OnlyDefaultBranch benar, hanya sertakan pemberitahuan yang ditemukan di cabang default atau cabang eksekusi terakhir jika tidak ada konfigurasi analisis untuk cabang default. Jika tidak, sertakan pemberitahuan dari semua cabang.
criteria.ruleId	query		string	Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. Jika tidak, kembalikan pemberitahuan dari semua aturan.
criteria.ruleName	query		string	Jika disediakan, hanya kembalikan pemberitahuan untuk aturan ini. Jika tidak, kembalikan pemberitahuan untuk semua aturan.
criteria.severities	query		string[]	Jika disediakan, hanya kembalikan pemberitahuan pada tingkat keparahan ini. Jika tidak, kembalikan pemberitahuan di serveritas apa pun.
criteria.states	query		string[]	Jika disediakan, hanya kembalikan pemberitahuan di status ini. Jika tidak, kembalikan pemberitahuan dalam status apa pun.
criteria.toDate	query		string date-time	Jika disediakan, hanya kembalikan pemberitahuan yang terakhir terlihat sebelum tanggal ini. Jika tidak, kembalikan semua pemberitahuan.
criteria.toolName	query		string	Jika disediakan dengan toolName, hanya kembalikan pemberitahuan yang terdeteksi oleh alat ini. Jika tidak, kembalikan pemberitahuan yang terdeteksi oleh semua alat.
orderBy	query		string	Harus "id" "firstSeen" "lastSeen" "fixedOn" atau "severity" Default ke "id"
top	query		integer int32	Jumlah maksimum pemberitahuan yang akan dikembalikan

Respons

Nama	Jenis	Deskripsi
200 OK	Alert[]	operasi berhasil

Keamanan

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: 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

Scopes

Nama	Deskripsi
vso.advsec	Memberikan kemampuan untuk membaca pemberitahuan, instans hasil, instans hasil analisis

Definisi

Nama	Deskripsi
Alert
AlertType	Jenis pemberitahuan. Misalnya rahasia, kode, dll.
Confidence	Tingkat keyakinan pemberitahuan.
Dismissal	Informasi tentang pemberhentian pemberitahuan
DismissalType	Alasan pemecatan
IdentityRef
LogicalLocation
PhysicalLocation	Lokasi dalam sistem kontrol sumber tempat masalah ditemukan
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
Region
RelationMetadata	Metadata yang akan dikaitkan dengan pemberitahuan.
Rule	Aturan analisis yang menyebabkan pemberitahuan.
Severity	Tingkat keparahan pemberitahuan.
State	Nilai ini dihitung dan dikembalikan oleh layanan. Ini adalah nilai berdasarkan hasil dari semua konfigurasi analisis.
Tool	Alat Analisis yang dapat menghasilkan pemberitahuan keamanan
ValidationFingerprint
VersionControlDetails	Informasi untuk menemukan file dalam sistem kontrol sumber

Alert

Nama	Jenis	Deskripsi
alertId	integer	Pengidentifikasi untuk pemberitahuan. Ini tidak diperlukan dalam organisasi Azure DevOps.
alertType	AlertType	Jenis pemberitahuan. Misalnya rahasia, kode, dll.
confidence	Confidence	Tingkat keyakinan pemberitahuan.
dismissal	Dismissal	Berisi informasi untuk pemberhentian pemberitahuan jika pemberitahuan telah dihentikan.
firstSeenDate	string	Nilai ini dihitung dan dikembalikan oleh layanan. Nilai ini menunjukkan pertama kalinya layanan melihat masalah ini dilaporkan dalam instans analisis.
fixedDate	string	Nilai ini dihitung dan dikembalikan oleh layanan. Jika masalah diperbaiki, nilai ini menunjukkan waktu layanan telah melihat masalah ini diperbaiki dalam instans analisis.
gitRef	string	Referensi ke objek git, misalnya ref cabang.
introducedDate	string	Nilai ini dihitung dan dikembalikan oleh layanan. Nilai ini menunjukkan pertama kalinya kerentanan diperkenalkan.
lastSeenDate	string	Nilai ini dihitung dan dikembalikan oleh layanan. Nilai ini menunjukkan terakhir kali layanan melihat masalah ini dilaporkan dalam instans analisis.
logicalLocations	LogicalLocation[]	Lokasi logis untuk pemberitahuan. Nilai ini dihitung dan dikembalikan oleh layanan. Ini adalah nilai berdasarkan hasil dari semua konfigurasi analisis. Contoh lokasi logis adalah komponen.
physicalLocations	PhysicalLocation[]	Nilai ini dihitung dan dikembalikan oleh layanan. Ini adalah nilai berdasarkan hasil dari semua konfigurasi analisis. Contoh lokasi fisik adalah lokasi file.
relations	RelationMetadata[]	Hubungan antara pemberitahuan dan artefak lainnya.
repositoryUrl	string	URL repositori tempat pemberitahuan terdeteksi.
severity	Severity	Tingkat keparahan pemberitahuan.
state	State	Nilai ini dihitung dan dikembalikan oleh layanan. Ini adalah nilai berdasarkan hasil dari semua konfigurasi analisis.
title	string	Judul hanya akan dirender sebagai teks dan tidak mendukung pemformatan markdown. Ada batas karakter maksimum 256.
tools	Tool[]	Alat yang telah mendeteksi masalah ini.
truncatedSecret	string	Versi rahasia yang dipoting/dikaburkan yang berkaitan dengan pemberitahuan (jika berlaku).
validationFingerprints	ValidationFingerprint[]	ValidationFingerprints untuk pemeriksaan keaktifan rahasia. Hanya dikembalikan sesuai permintaan di Get API dengan parameter Perluas yang diatur menjadi ValidationFingerprint (tidak dikembalikan di List API)

AlertType

Jenis pemberitahuan. Misalnya rahasia, kode, dll.

Nama	Jenis	Deskripsi
code	string	Kode berisi kelemahan yang ditentukan oleh analisis statis.
dependency	string	Kode ini menggunakan dependensi dengan kerentanan yang diketahui.
license	string	Kode ini menggunakan dependensi dengan potensi ketidakpatuh lisensi.
secret	string	Kode berisi rahasia yang sekarang telah disusupi dan harus dicabut.
unknown	string	Kode memiliki jenis kerentanan yang tidak ditentukan

Confidence

Tingkat keyakinan pemberitahuan.

Nama	Jenis	Deskripsi
high	string	Tingkat keyakinan tinggi untuk pemberitahuan
other	string	Tingkat keyakinan lainnya untuk pemberitahuan

Dismissal

Informasi tentang pemberhentian pemberitahuan

Nama	Jenis	Deskripsi
dismissalId	integer	ID unik untuk pemberhentian ini
dismissalType	DismissalType	Alasan pemecatan
message	string	Pesan informasi yang dilampirkan ke pemecatan
stateChangedBy	string	Identitas yang menutup pemberitahuan
stateChangedByIdentity	IdentityRef	Identitas yang menutup pemberitahuan

DismissalType

Alasan pemecatan

Nama	Jenis	Deskripsi
acceptedRisk	string	Pemecatan yang menunjukkan pengguna menerima risiko untuk pemberitahuan
falsePositive	string	Pemecatan yang menunjukkan pemberitahuan adalah positif palsu dan kemungkinan tidak akan diperbaiki.
fixed	string	Pemecatan menunjukkan peringatan telah diperbaiki
unknown	string	Tipe pemecatan tidak diketahui

IdentityRef

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan secara unik mengidentifikasi subjek grafik yang sama di seluruh Akun dan Organisasi.
directoryAlias	string	Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links"
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string	Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"
inactive	boolean	Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" dari kamus "_links" GraphUser
isAadIdentity	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya
uniqueName	string	Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

LogicalLocation

Nama	Jenis	Deskripsi
fullyQualifiedName	string
kind	string	Nilai yang mungkin: "tidak diketahui" "rootDependency" dan "vulnerableDependency"

PhysicalLocation

Lokasi dalam sistem kontrol sumber tempat masalah ditemukan

Nama	Jenis	Deskripsi
filePath	string	Jalur file tempat masalah ditemukan
region	Region	Detail tentang lokasi tempat masalah ditemukan termasuk cuplikan
versionControl	VersionControlDetails	Informasi khusus sistem kontrol sumber tentang lokasi

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja.

Region

Nama	Jenis	Deskripsi
columnEnd	integer	Kolom tempat cuplikan kode berakhir
columnStart	integer	Kolom tempat cuplikan kode dimulai
lineEnd	integer	Nomor baris tempat cuplikan kode berakhir
lineStart	integer	Nomor baris tempat cuplikan kode dimulai

RelationMetadata

Metadata yang akan dikaitkan dengan pemberitahuan.

Nama	Jenis	Deskripsi
attributes	object	Atribut tambahan metadata apa pun.
rel	string	Jenis metadata.
url	string	URL metadata.

Rule

Aturan analisis yang menyebabkan pemberitahuan.

Nama	Jenis	Deskripsi
additionalProperties	object	Properti tambahan dari aturan ini bergantung pada jenis aturan. Misalnya, aturan dependensi dapat menyertakan ID CVE jika tersedia.
description	string	Deskripsi tentang apa yang dideteksi aturan ini
friendlyName	string	Pengidentifikasi aturan teks biasa
helpMessage	string	Informasi tambahan tentang aturan ini
opaqueId	string	Pengidentifikasi aturan khusus alat
resources	string	Daftar sumber daya berformat markdown untuk mempelajari selengkapnya tentang Aturan. Dalam beberapa kasus, RuleInfo.AdditionalProperties.advisoryUrls digunakan sebagai gantinya.
tags	string[]	Tag klasifikasi untuk aturan ini

Severity

Tingkat keparahan pemberitahuan.

Nama	Jenis	Deskripsi
critical	string
error	string
high	string
low	string
medium	string
note	string
undefined	string
warning	string

State

Nilai ini dihitung dan dikembalikan oleh layanan. Ini adalah nilai berdasarkan hasil dari semua konfigurasi analisis.

Nama	Jenis	Deskripsi
active	string	Pemberitahuan telah terdeteksi dalam kode
autoDismissed	string	Alat ini telah menentukan bahwa masalah ini tidak lagi menjadi risiko
dismissed	string	Pemberitahuan dihentikan oleh pengguna
fixed	string	Masalah ini tidak lagi terdeteksi dalam kode
unknown	string	Pemberitahuan dalam status tidak ditentukan

Tool

Alat Analisis yang dapat menghasilkan pemberitahuan keamanan

Nama	Jenis	Deskripsi
name	string	Nama alat
rules	Rule[]	Aturan yang didefinisikan alat

ValidationFingerprint

Nama	Jenis	Deskripsi
validationFingerprintHash	string
validationFingerprintJson	string

VersionControlDetails

Informasi untuk menemukan file dalam sistem kontrol sumber

Nama	Jenis	Deskripsi
commitHash	string
itemUrl	string

Bagikan melalui