Skip to content

UpdateThreatInput

Source code in docs_src/capo_securityagent/types/update_threat_input.py
class UpdateThreatInput(TypedDict, closed=True):
    threat_id: "str"
    """<p>The unique identifier of the threat to update.</p>"""
    agent_space_id: "str"
    """<p>The unique identifier of the agent space.</p>"""
    title: NotRequired["str"]
    """<p>A short title summarizing the threat.</p>"""
    status: NotRequired["capo_securityagent.types.threat_status.ThreatStatus"]
    """<p>The updated status of the threat.</p>"""
    comments: NotRequired["str"]
    """<p>Optional customer comment.</p>"""
    statement: NotRequired["str"]
    """<p>The updated natural-language threat statement.</p>"""
    severity: NotRequired["capo_securityagent.types.threat_severity.ThreatSeverity"]
    """<p>The updated severity level of the threat.</p>"""
    threat_source: NotRequired["str"]
    """<p>The updated actor or origin of the threat.</p>"""
    prerequisites: NotRequired["str"]
    """<p>The updated conditions required for the threat to be exploitable.</p>"""
    threat_action: NotRequired["str"]
    """<p>The updated description of what the threat source can do.</p>"""
    threat_impact: NotRequired["str"]
    """<p>The updated direct consequence of the threat action.</p>"""
    impacted_goal: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The updated security goals affected by the threat.</p>"""
    impacted_assets: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The updated list of specific assets affected by the threat.</p>"""
    anchor: NotRequired[
        "capo_securityagent.types.threat_anchor_shape.ThreatAnchorShape"
    ]
    """<p>The updated DFD element this threat is anchored to.</p>"""
    evidence: NotRequired[
        "capo_securityagent.types.threat_evidence_list.ThreatEvidenceList"
    ]
    """<p>The updated source code files supporting the threat.</p>"""
    recommendation: NotRequired["str"]
    """<p>The updated recommended mitigation guidance for this threat.</p>"""

agent_space_id instance-attribute

agent_space_id: str

The unique identifier of the agent space.

anchor instance-attribute

anchor: NotRequired[ThreatAnchorShape]

The updated DFD element this threat is anchored to.

comments instance-attribute

comments: NotRequired[str]

Optional customer comment.

evidence instance-attribute

evidence: NotRequired[ThreatEvidenceList]

The updated source code files supporting the threat.

impacted_assets instance-attribute

impacted_assets: NotRequired[StringList]

The updated list of specific assets affected by the threat.

impacted_goal instance-attribute

impacted_goal: NotRequired[StringList]

The updated security goals affected by the threat.

prerequisites instance-attribute

prerequisites: NotRequired[str]

The updated conditions required for the threat to be exploitable.

recommendation instance-attribute

recommendation: NotRequired[str]

The updated recommended mitigation guidance for this threat.

severity instance-attribute

severity: NotRequired[ThreatSeverity]

The updated severity level of the threat.

statement instance-attribute

statement: NotRequired[str]

The updated natural-language threat statement.

status instance-attribute

status: NotRequired[ThreatStatus]

The updated status of the threat.

threat_action instance-attribute

threat_action: NotRequired[str]

The updated description of what the threat source can do.

threat_id instance-attribute

threat_id: str

The unique identifier of the threat to update.

threat_impact instance-attribute

threat_impact: NotRequired[str]

The updated direct consequence of the threat action.

threat_source instance-attribute

threat_source: NotRequired[str]

The updated actor or origin of the threat.

title instance-attribute

title: NotRequired[str]

A short title summarizing the threat.