Skip to content

ThreatSummary

Source code in docs_src/capo_securityagent/types/threat_summary.py
class ThreatSummary(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>"""
    stride: NotRequired[
        "capo_securityagent.types.stride_category_list.StrideCategoryList"
    ]
    """<p>The STRIDE categories applicable to 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>"""

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.

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_id instance-attribute

threat_id: NotRequired[str]

The unique identifier of the threat.

threat_job_id instance-attribute

threat_job_id: NotRequired[str]

The unique identifier of the threat model job that produced 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.