Skip to main content
GET
获取代码扫描 Profile

权限

需要具有组织级 ViewCodeScans 权限的服务用户个人访问令牌

行为

返回 Profile 的元数据、可见性 (归组织所有或在账户级别共享) 、包含/排除 glob 模式,以及所有指导字段 (调查、沟通和导入源指导) 。可通过列出代码扫描 Profile查找 Profile ID。 当 Profile 不存在或对该组织不可见时,返回 404

授权

Authorization
string
header
必填

服务用户凭据(前缀:cog_)

路径参数

profile_id
string
必填
org_id
string
必填

Organization ID(前缀:org-)

示例:

"org-abc123def456"

响应

成功响应

代码扫描 Profile 的完整详细信息,包括其指导内容。

created_at
integer
必填

Profile 的创建时间(Unix 秒)。

description
string | null
必填

Profile 的描述(如有)。

exclude_globs
string[] | null
必填

要从扫描中排除的文件 Glob 模式(如有)。

include_globs
string[] | null
必填

要包含在扫描中的文件 Glob 模式(如有)。

ingestion_source_guidance
string | null
必填

描述摄取来源的指导内容(如有)。

investigation_guidance
string | null
必填

调查阶段的指导内容(如有)。

mode
enum<string>
必填

Profile 模式:discover 或 ingest。

可用选项:
discover,
ingest
name
string
必填

Profile 名称。

org_id
string | null
必填

拥有该 Profile 的组织。若该 Profile 为账户级共享,则为 null。

post_ingestion_guidance
string | null
必填

摄取后阶段的指导内容(如有)。

profile_id
string
必填

Profile 的唯一标识符。

remediation_guidance
string | null
必填

修复阶段的指导内容(如有)。

report_guidance
string | null
必填

报告阶段的指导内容(如有)。

scan_type
enum<string>
必填

该 Profile 配置的扫描类型。

可用选项:
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>
必填

该 Profile 是由单个组织拥有,还是在整个账户范围内共享。

可用选项:
org,
account
communication_guidance
string | null

通信阶段的指引(对最终发现项采取行动,例如通知负责人或利益相关者),如有。