Skip to content

Finding

Source code in docs_src/capo_securityagent/types/finding.py
class Finding(TypedDict, closed=True):
    finding_id: "str"
    """<p>The unique identifier of the finding.</p>"""
    agent_space_id: "str"
    """<p>The unique identifier of the agent space associated with the finding.</p>"""
    pentest_id: NotRequired["str"]
    """<p>The unique identifier of the pentest associated with the finding.</p>"""
    pentest_job_id: NotRequired["str"]
    """<p>The unique identifier of the pentest job that produced the finding.</p>"""
    code_review_id: NotRequired["str"]
    """<p>The unique identifier of the code review associated with the finding.</p>"""
    code_review_job_id: NotRequired["str"]
    """<p>The unique identifier of the code review job that produced the finding.</p>"""
    task_id: NotRequired["str"]
    """<p>The unique identifier of the task that produced the finding.</p>"""
    name: NotRequired["str"]
    """<p>The name of the finding.</p>"""
    description: NotRequired["str"]
    """<p>A description of the finding.</p>"""
    status: NotRequired["capo_securityagent.types.finding_status.FindingStatus"]
    """<p>The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.</p>"""
    risk_type: NotRequired["str"]
    """<p>The type of security risk identified by the finding.</p>"""
    risk_level: NotRequired["capo_securityagent.types.risk_level.RiskLevel"]
    """<p>The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.</p>"""
    risk_score: NotRequired["str"]
    """<p>The numerical risk score of the finding.</p>"""
    reasoning: NotRequired["str"]
    """<p>The reasoning behind the finding, explaining why it was identified as a vulnerability.</p>"""
    confidence: NotRequired["capo_securityagent.types.confidence_level.ConfidenceLevel"]
    """<p>The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.</p>"""
    validation_status: NotRequired[
        "capo_securityagent.types.validation_status.ValidationStatus"
    ]
    """<p>The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED.</p>"""
    attack_script: NotRequired["str"]
    """<p>The attack script used to reproduce the finding.</p>"""
    remediation_code: NotRequired["str"]
    """<p>The suggested fix for the finding, describing the changes recommended to remediate the vulnerability, with example code or configuration.</p>"""
    code_remediation_task: NotRequired[
        "capo_securityagent.types.code_remediation_task.CodeRemediationTask"
    ]
    """<p>The code remediation task associated with the finding, if code remediation was initiated.</p>"""
    last_updated_by: NotRequired["str"]
    """<p>The identifier of the entity that last updated the finding.</p>"""
    customer_note: NotRequired["str"]
    """<p>A customer-provided note on the finding.</p>"""
    code_locations: NotRequired[
        "capo_securityagent.types.code_location_list.CodeLocationList"
    ]
    """<p>The file locations involved in the vulnerability, as reported by the code scanner.</p>"""
    verification_script: NotRequired[
        "capo_securityagent.types.verification_script.VerificationScript"
    ]
    """<p>The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables.</p>"""
    alignment_rationale: NotRequired["str"]
    """<p>The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences.</p>"""
    revalidation_job_ids: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The list of pentest job identifiers for revalidation jobs that retested this finding.</p>"""
    original_finding_id: NotRequired["str"]
    """<p>The identifier of the original finding that this revalidation finding was produced from.</p>"""
    linked_issue: NotRequired["capo_securityagent.types.linked_issue.LinkedIssue"]
    """<p>The issue in a third-party issue tracker that this finding has been exported to.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the finding was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the finding was last updated, in UTC format.</p>"""

agent_space_id instance-attribute

agent_space_id: str

The unique identifier of the agent space associated with the finding.

alignment_rationale instance-attribute

alignment_rationale: NotRequired[str]

The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences.

attack_script instance-attribute

attack_script: NotRequired[str]

The attack script used to reproduce the finding.

code_locations instance-attribute

code_locations: NotRequired[CodeLocationList]

The file locations involved in the vulnerability, as reported by the code scanner.

code_remediation_task instance-attribute

code_remediation_task: NotRequired[CodeRemediationTask]

The code remediation task associated with the finding, if code remediation was initiated.

code_review_id instance-attribute

code_review_id: NotRequired[str]

The unique identifier of the code review associated with the finding.

code_review_job_id instance-attribute

code_review_job_id: NotRequired[str]

The unique identifier of the code review job that produced the finding.

confidence instance-attribute

confidence: NotRequired[ConfidenceLevel]

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

created_at instance-attribute

created_at: NotRequired[datetime]

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

customer_note instance-attribute

customer_note: NotRequired[str]

A customer-provided note on the finding.

description instance-attribute

description: NotRequired[str]

A description of the finding.

finding_id instance-attribute

finding_id: str

The unique identifier of the finding.

last_updated_by instance-attribute

last_updated_by: NotRequired[str]

The identifier of the entity that last updated the finding.

linked_issue instance-attribute

linked_issue: NotRequired[LinkedIssue]

The issue in a third-party issue tracker that this finding has been exported to.

name instance-attribute

name: NotRequired[str]

The name of the finding.

original_finding_id instance-attribute

original_finding_id: NotRequired[str]

The identifier of the original finding that this revalidation finding was produced from.

pentest_id instance-attribute

pentest_id: NotRequired[str]

The unique identifier of the pentest associated with the finding.

pentest_job_id instance-attribute

pentest_job_id: NotRequired[str]

The unique identifier of the pentest job that produced the finding.

reasoning instance-attribute

reasoning: NotRequired[str]

The reasoning behind the finding, explaining why it was identified as a vulnerability.

remediation_code instance-attribute

remediation_code: NotRequired[str]

The suggested fix for the finding, describing the changes recommended to remediate the vulnerability, with example code or configuration.

revalidation_job_ids instance-attribute

revalidation_job_ids: NotRequired[StringList]

The list of pentest job identifiers for revalidation jobs that retested this finding.

risk_level instance-attribute

risk_level: NotRequired[RiskLevel]

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

risk_score instance-attribute

risk_score: NotRequired[str]

The numerical risk score of the finding.

risk_type instance-attribute

risk_type: NotRequired[str]

The type of security risk identified by the finding.

status instance-attribute

status: NotRequired[FindingStatus]

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

task_id instance-attribute

task_id: NotRequired[str]

The unique identifier of the task that produced the finding.

updated_at instance-attribute

updated_at: NotRequired[datetime]

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

validation_status instance-attribute

validation_status: NotRequired[ValidationStatus]

The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED.

verification_script instance-attribute

verification_script: NotRequired[VerificationScript]

The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables.