Skip to main content
GET
コードスキャンプロファイルを取得

権限

Enterprise レベルで ViewAccountCodeScans 権限を持つサービスユーザーまたはパーソナルアクセストークンが必要です。

動作

スキャンプロファイルのメタデータ、可視性 (組織所有またはアカウント全体で共有) 、包含/除外グロブ、すべてのガイダンスフィールド (調査、コミュニケーション、取り込みソースに関するガイダンス) を返します。 スキャンプロファイルが存在しない場合、またはEnterpriseアカウントから参照できない場合は、404を返します。組織スコープでの同等のエンドポイントについては、Get Code Scan スキャンプロファイル (Organization)を参照してください。

承認

Authorization
string
header
必須

サービスユーザーの認証情報(接頭辞: cog_)

パスパラメータ

profile_id
string
必須

レスポンス

成功レスポンス

ガイダンスを含むコードスキャンプロファイルの詳細情報。

created_at
integer
必須

プロファイルが作成された日時(Unix 秒)。

description
string | null
必須

プロファイルの説明(ある場合)。

exclude_globs
string[] | null
必須

スキャンから除外するファイルの glob パターン(ある場合)。

include_globs
string[] | null
必須

スキャンに含めるファイルの glob パターン(ある場合)。

ingestion_source_guidance
string | null
必須

取り込みソースを説明するガイダンス(ある場合)。

investigation_guidance
string | null
必須

調査フェーズのガイダンス(ある場合)。

mode
enum<string>
必須

プロファイルモード: discover または ingest。

利用可能なオプション:
discover,
ingest
name
string
必須

プロファイル名。

org_id
string | null
必須

プロファイルを所有する組織。プロファイルがアカウント全体で共有されている場合は null。

post_ingestion_guidance
string | null
必須

取り込み後フェーズのガイダンス(ある場合)。

profile_id
string
必須

プロファイルの一意の識別子。

remediation_guidance
string | null
必須

修復フェーズのガイダンス(ある場合)。

report_guidance
string | null
必須

レポートフェーズのガイダンス(ある場合)。

scan_type
enum<string>
必須

プロファイルが設定するスキャンの種類。

利用可能なオプション:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
threat_model_guidance
string | null
必須

脅威モデルに関するガイダンス(ある場合)。

triage_guidance
string | null
必須

トリアージ段階に関するガイダンス(ある場合)。

validation_guidance
string | null
必須

検証段階に関するガイダンス(ある場合)。

visibility
enum<string>
必須

このプロファイルが単一の組織に属するか、アカウント全体で共有されるかどうか。

利用可能なオプション:
org,
account
communication_guidance
string | null

通信フェーズ(最終的な検出結果への対応。例: 所有者または関係者への通知)に関するガイダンス(該当する場合)。