Skip to content

UpdateThreatOutput

Source code in docs_src/capo_securityagent/types/update_threat_output.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class UpdateThreatOutput(TypedDict, closed=True):
    threat_id: "str"
    """<p>The unique identifier of the threat.</p>"""
    threat_job_id: "str"
    """<p>The unique identifier of the threat model job the threat belongs to.</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>"""
    stride: NotRequired[
        "capo_securityagent.types.stride_category_list.StrideCategoryList"
    ]
    """<p>The STRIDE categories applicable to this 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>"""
    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>"""

anchor instance-attribute 

anchor: NotRequired[ThreatAnchorShape]

The DFD element this threat is anchored to.

comments instance-attribute 

comments: NotRequired[str]

Optional customer comment on the threat.

created_at instance-attribute 

created_at: NotRequired[datetime]

The date and time the threat was created, in UTC format.

created_by instance-attribute 

created_by: NotRequired[ThreatActor]

Who created this threat.

evidence instance-attribute 

evidence: NotRequired[ThreatEvidenceList]

The source code files supporting the threat.

impacted_assets instance-attribute 

impacted_assets: NotRequired[StringList]

The specific assets affected by the threat.

impacted_goal instance-attribute 

impacted_goal: NotRequired[StringList]

The security goals affected by the threat.

prerequisites instance-attribute 

prerequisites: NotRequired[str]

The conditions required for the threat to be exploitable.

recommendation instance-attribute 

recommendation: NotRequired[str]

The recommended mitigation guidance for this threat.

severity instance-attribute 

severity: NotRequired[ThreatSeverity]

The severity level of the threat.

statement instance-attribute 

statement: NotRequired[str]

The natural-language threat statement.

status instance-attribute 

status: NotRequired[ThreatStatus]

The current status of the threat.

stride instance-attribute 

stride: NotRequired[StrideCategoryList]

The STRIDE categories applicable to this threat.

threat_action instance-attribute 

threat_action: NotRequired[str]

What the threat source can do.

threat_id instance-attribute 

threat_id: str

The unique identifier of the threat.

threat_impact instance-attribute 

threat_impact: NotRequired[str]

The direct consequence of the threat action.

threat_job_id instance-attribute 

threat_job_id: str

The unique identifier of the threat model job the threat belongs to.

threat_source instance-attribute 

threat_source: NotRequired[str]

The actor or origin of the threat.

title instance-attribute 

title: NotRequired[str]

A short title summarizing the threat.

updated_at instance-attribute 

updated_at: NotRequired[datetime]

The date and time the threat was last updated, in UTC format.

updated_by instance-attribute 

updated_by: NotRequired[ThreatActor]

Who last updated this threat.