Skip to content

ThreatModelJob

Source code in docs_src/capo_securityagent/types/threat_model_job.py
class ThreatModelJob(TypedDict, closed=True):
    threat_model_job_id: NotRequired["str"]
    """<p>The unique identifier of the threat model job.</p>"""
    threat_model_id: NotRequired["str"]
    """<p>The unique identifier of the threat model associated with the job.</p>"""
    agent_space_id: NotRequired["str"]
    """<p>The unique identifier of the agent space.</p>"""
    title: NotRequired["str"]
    """<p>The title of the threat model job.</p>"""
    status: NotRequired["capo_securityagent.types.job_status.JobStatus"]
    """<p>The current status of the threat model job.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the threat model job was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the threat model job was last updated, in UTC format.</p>"""
    execution_start_time: NotRequired["datetime.datetime"]
    """<p>The date and time the threat model job execution started, in UTC format.</p>"""
    execution_end_time: NotRequired["datetime.datetime"]
    """<p>The date and time the threat model job execution ended, in UTC format.</p>"""
    source_code: NotRequired[
        "capo_securityagent.types.source_code_repository_list.SourceCodeRepositoryList"
    ]
    """<p>The list of source code repositories used for threat modeling.</p>"""
    integrated_repositories: NotRequired[
        "capo_securityagent.types.integrated_repository_list.IntegratedRepositoryList"
    ]
    """<p>The list of integrated repositories used for threat modeling.</p>"""
    documents: NotRequired["capo_securityagent.types.document_list.DocumentList"]
    """<p>The list of documents used for threat modeling.</p>"""
    scope_docs: NotRequired["capo_securityagent.types.document_list.DocumentList"]
    """<p>The scoped documents for the agent to focus on during threat modeling.</p>"""
    error_information: NotRequired[
        "capo_securityagent.types.error_information.ErrorInformation"
    ]
    """<p>Error information if the threat model job encountered an error.</p>"""
    system_overview: NotRequired["str"]
    """<p>The system overview generated during threat modeling.</p>"""
    report_destination: NotRequired[
        "capo_securityagent.types.report_destination.ReportDestination"
    ]
    """<p>The destination for publishing scan reports to an integrated document provider.</p>"""

agent_space_id instance-attribute

agent_space_id: NotRequired[str]

The unique identifier of the agent space.

created_at instance-attribute

created_at: NotRequired[datetime]

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

documents instance-attribute

documents: NotRequired[DocumentList]

The list of documents used for threat modeling.

error_information instance-attribute

error_information: NotRequired[ErrorInformation]

Error information if the threat model job encountered an error.

execution_end_time instance-attribute

execution_end_time: NotRequired[datetime]

The date and time the threat model job execution ended, in UTC format.

execution_start_time instance-attribute

execution_start_time: NotRequired[datetime]

The date and time the threat model job execution started, in UTC format.

integrated_repositories instance-attribute

integrated_repositories: NotRequired[IntegratedRepositoryList]

The list of integrated repositories used for threat modeling.

report_destination instance-attribute

report_destination: NotRequired[ReportDestination]

The destination for publishing scan reports to an integrated document provider.

scope_docs instance-attribute

scope_docs: NotRequired[DocumentList]

The scoped documents for the agent to focus on during threat modeling.

source_code instance-attribute

source_code: NotRequired[SourceCodeRepositoryList]

The list of source code repositories used for threat modeling.

status instance-attribute

status: NotRequired[JobStatus]

The current status of the threat model job.

system_overview instance-attribute

system_overview: NotRequired[str]

The system overview generated during threat modeling.

threat_model_id instance-attribute

threat_model_id: NotRequired[str]

The unique identifier of the threat model associated with the job.

threat_model_job_id instance-attribute

threat_model_job_id: NotRequired[str]

The unique identifier of the threat model job.

title instance-attribute

title: NotRequired[str]

The title of the threat model job.

updated_at instance-attribute

updated_at: NotRequired[datetime]

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