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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
repository	path	True	string	リポジトリの名前または ID
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.2-preview.1' に設定する必要があります。
continuationToken	query		string	返されるよりも多くのアラートがある場合は、継続トークンが "x-ms-continuationtoken" ヘッダーに配置されます。このトークンを使用して、アラートの次のページを取得します
criteria.alertIds	query		integer[]	指定した場合は、ID が指定されたアラートのみを返します。それ以外の場合は、アラートを返します。
criteria.alertType	query		AlertType	指定した場合は、この種類のアラートのみを返します。それ以外の場合は、すべての種類のアラートを返します。
criteria.confidenceLevels	query		string[]	指定した場合は、これらの信頼度レベルでのみアラートを返します。すべての信頼レベルのアラートをフェッチするには、High と Other の両方を指定する必要があります。それ以外の場合は、信頼度の高いアラートを返します。
criteria.dependencyName	query		string	指定した場合、この依存関係のアラートのみが返されます。それ以外の場合は、すべての依存関係のアラートを返します。 sarif 送信では、依存関係 (またはコンポーネント) が結果で指定されます。RelatedLocations[].logicalLocation.
criteria.fromDate	query		string date-time	指定した場合は、この日付より後に最後に表示されたアラートのみを返します。それ以外の場合は、すべてのアラートを返します。
criteria.keywords	query		string	指定した場合は、タイトルがこのパターンと一致するアラートのみを返します。
criteria.licenseName	query		string	指定した場合、このライセンスとの依存関係のために作成されたアラートのみが返されます。それ以外の場合は、すべてのライセンスのアラートを返します。サリフ提出では、結果として依存関係 (またはコンポーネント) のライセンスが指定されます。RelatedLocations[].logicalLocation.properties.license.
criteria.modifiedSince	query		string date-time	指定した場合は、この日付以降に変更されたアラートのみを返します。それ以外の場合は、すべてのアラートを返します。
criteria.onlyDefaultBranch	query		boolean	true または設定されていない場合は、リポジトリの既定のブランチで検出されたアラートのみを返します。既定のブランチで実行が完了していない場合は、その実行に使用されるブランチに関係なく、最後の実行が代わりに使用されます。 false の場合は、すべてのブランチからアラートを返します。 ref が指定されている場合、このオプションは無視されます。
criteria.phaseId	query		string uuid	pipelineName を指定した場合は、このパイプラインフェーズで検出されたアラートのみを返しますそれ以外の場合は、すべてのフェーズで検出されたアラートを返します。
criteria.phaseName	query		string	pipelineName を指定した場合は、このパイプラインフェーズで検出されたアラートのみを返しますそれ以外の場合は、すべてのフェーズで検出されたアラートを返します。
criteria.pipelineName	query		string	指定した場合は、このパイプラインで検出されたアラートのみを返します。それ以外の場合は、すべてのパイプラインで検出されたアラートを返します。
criteria.ref	query		string	指定した場合は、この ref のアラートのみを含めます。指定されず、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 を指定した場合は、このツールによって検出されたアラートのみを返します。それ以外の場合は、すべてのツールによって検出されたアラートを返します。
orderBy	query		string	"id" "firstSeen" "lastSeen" "fixedOn" または "severity" の既定値は "id" にする必要があります
top	query		integer int32	返されるアラートの最大数

応答

名前	型	説明
200 OK	Alert[]	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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	アラートの種類。シークレット、コードなど
Confidence	アラートの信頼度レベル。
DependencyKind	この論理的な場所の依存関係の種類。
Dismissal	アラートの無視に関する情報
DismissalType	解雇の理由
IdentityRef
License	依存関係のライセンス情報
LicenseState	ライセンスの状態
LogicalLocation
PhysicalLocation	問題が見つかったソース管理システム内の場所
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
Region
RelationMetadata	アラートに関連付けるメタデータ。
Rule	アラートの原因となった分析ルール。
Severity	アラートの重大度。
State	この値は、サービスによって計算され、返されます。これは、すべての分析構成の結果に基づく値です。
Tool	セキュリティアラートを生成できる分析ツール
ValidationFingerprint
VersionControlDetails	ソース管理システムでファイルを検索するための情報

Alert

名前	型	説明
alertId	integer	アラートの識別子。 Azure DevOps 組織内では unqiue です。
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	タイトルはテキストとしてのみレンダリングされ、マークダウンの書式設定はサポートされません。文字の上限は 256 です。
tools	Tool[]	この問題を検出したツール。
truncatedSecret	string	アラートに関連するシークレットの切り捨て/難読化されたバージョン (該当する場合)。
validationFingerprints	ValidationFingerprint[]	シークレットのライブネスチェックの ValidationFingerprints。 Expand パラメーターが ValidationFingerprint に設定された Get API でのみオンデマンドで返されます (List API では返されません)

AlertType

アラートの種類。シークレット、コードなど

名前	型	説明
code	string	このコードには、静的分析によって決定される弱点が含まれています。
dependency	string	このコードでは、既知の脆弱性を持つ依存関係が使用されます。
license	string	このコードでは、潜在的なライセンスに準拠していない依存関係が使用されます。
secret	string	このコードには、侵害されたシークレットが含まれており、取り消す必要があります。
unknown	string	コードに未指定の脆弱性の種類がある

Confidence

アラートの信頼度レベル。

名前	型	説明
high	string	アラートの高い信頼度レベル
other	string	アラートのその他の信頼度レベル

DependencyKind

この論理的な場所の依存関係の種類。

名前	型	説明
component	string	アラートを受け取るコンポーネント。
rootDependency	string	ルート依存関係によって、アラートが生成されるコンポーネントが導入されました。
unknown	string
vulnerableDependency	string	脆弱な依存関係。この値を非推奨にしました。代わりにコンポーネントを使用してください。

Dismissal

アラートの無視に関する情報

名前	型	説明
dismissalId	integer	この無視の一意の ID
dismissalType	DismissalType	解雇の理由
message	string	無視に添付された情報メッセージ
stateChangedBy	string	アラートを無視した ID
stateChangedByIdentity	IdentityRef	アラートを無視した ID

DismissalType

解雇の理由

名前	型	説明
acceptedRisk	string	ユーザーがアラートのリスクを受け入れることを示す無視
agreedToGuidance	string	ユーザーがライセンスガイダンスに従うことに同意したことを示す無視。
falsePositive	string	アラートが誤検知であることを示す無視は修正されない可能性があります。
fixed	string	アラートが修正されたことを示す無視
unknown	string	無視の型が不明です

IdentityRef

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
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	種類が "コンポーネント" で、この場所のアラートの alertType が 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 ID が使用可能な場合は、依存関係ルールに CVE ID が含まれる場合があります。
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

VersionControlDetails

ソース管理システムでファイルを検索するための情報

名前	型	説明
commitHash	string
itemUrl	string

次の方法で共有