Threat ¶

class Threat(TypedDict, closed=True):
    threat_id: NotRequired["str"]
    """<p>The unique identifier of the threat.</p>"""
    threat_job_id: NotRequired["str"]
    """<p>The unique identifier of the threat model job that produced the threat.</p>"""
    title: NotRequired["str"]
    """<p>A short title summarizing the threat.</p>"""
    statement: NotRequired["str"]
    """<p>The natural-language threat statement.</p>"""
    severity: NotRequired["capo_securityagent.types.threat_severity.ThreatSeverity"]
    """<p>The severity level of the threat.</p>"""
    status: NotRequired["capo_securityagent.types.threat_status.ThreatStatus"]
    """<p>The current status of the threat.</p>"""
    comments: NotRequired["str"]
    """<p>Optional customer comment on the threat.</p>"""
    threat_source: NotRequired["str"]
    """<p>The actor or origin of the threat.</p>"""
    prerequisites: NotRequired["str"]
    """<p>The conditions required for the threat to be exploitable.</p>"""
    threat_action: NotRequired["str"]
    """<p>What the threat source can do.</p>"""
    threat_impact: NotRequired["str"]
    """<p>The direct consequence of the threat action.</p>"""
    impacted_goal: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The security goals affected by the threat.</p>"""
    impacted_assets: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The specific assets affected by the threat.</p>"""
    anchor: NotRequired[
        "capo_securityagent.types.threat_anchor_shape.ThreatAnchorShape"
    ]
    """<p>The DFD element this threat is anchored to.</p>"""
    evidence: NotRequired[
        "capo_securityagent.types.threat_evidence_list.ThreatEvidenceList"
    ]
    """<p>The source code files supporting the threat.</p>"""
    stride: NotRequired[
        "capo_securityagent.types.stride_category_list.StrideCategoryList"
    ]
    """<p>The STRIDE categories applicable to this threat.</p>"""
    recommendation: NotRequired["str"]
    """<p>The recommended mitigation guidance for this threat.</p>"""
    created_by: NotRequired["capo_securityagent.types.threat_actor.ThreatActor"]
    """<p>Who created this threat.</p>"""
    updated_by: NotRequired["capo_securityagent.types.threat_actor.ThreatActor"]
    """<p>Who last updated this threat.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the threat was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the threat was last updated, in UTC format.</p>"""