SecurityAgent / Client / batch_get_threats

batch_get_threats¶

SecurityAgent.Client.batch_get_threats(**kwargs)¶

Retrieves information about one or more threats.

Request Syntax

response = client.batch_get_threats(
    threatIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

threatIds (list) –
[REQUIRED]

The list of threat identifiers to retrieve.
- (string) –
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space.

Return type:

dict

Returns:

Response Syntax

{
    'threats': [
        {
            'threatId': 'string',
            'threatJobId': 'string',
            'title': 'string',
            'statement': 'string',
            'severity': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'INFO',
            'status': 'OPEN'|'RESOLVED'|'DISMISSED',
            'comments': 'string',
            'threatSource': 'string',
            'prerequisites': 'string',
            'threatAction': 'string',
            'threatImpact': 'string',
            'impactedGoal': [
                'string',
            ],
            'impactedAssets': [
                'string',
            ],
            'anchor': {
                'kind': 'string',
                'id': 'string',
                'packageId': 'string'
            },
            'evidence': [
                {
                    'packageId': 'string',
                    'path': 'string'
                },
            ],
            'stride': [
                'SPOOFING'|'TAMPERING'|'REPUDIATION'|'INFORMATION_DISCLOSURE'|'DENIAL_OF_SERVICE'|'ELEVATION_OF_PRIVILEGE',
            ],
            'recommendation': 'string',
            'createdBy': 'CUSTOMER'|'AGENT',
            'updatedBy': 'CUSTOMER'|'AGENT',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

(dict) –

Output for the BatchGetThreats operation.
- threats (list) –
  
  The list of threats that were found.
  - (dict) –
    
    Represents a threat identified during threat modeling.
    - threatId (string) –
      
      The unique identifier of the threat.
    - threatJobId (string) –
      
      The unique identifier of the threat model job that produced the threat.
    - title (string) –
      
      A short title summarizing the threat.
    - statement (string) –
      
      The natural-language threat statement.
    - severity (string) –
      
      The severity level of the threat.
    - status (string) –
      
      The current status of the threat.
    - comments (string) –
      
      Optional customer comment on the threat.
    - threatSource (string) –
      
      The actor or origin of the threat.
    - prerequisites (string) –
      
      The conditions required for the threat to be exploitable.
    - threatAction (string) –
      
      What the threat source can do.
    - threatImpact (string) –
      
      The direct consequence of the threat action.
    - impactedGoal (list) –
      
      The security goals affected by the threat.
      - (string) –
    - impactedAssets (list) –
      
      The specific assets affected by the threat.
      - (string) –
    - anchor (dict) –
      
      The DFD element this threat is anchored to.
      - kind (string) –
        
        The kind of DFD element.
      - id (string) –
        
        The identifier of the DFD element.
      - packageId (string) –
        
        The package identifier containing the DFD element.
    - evidence (list) –
      
      The source code files supporting the threat.
      - (dict) –
        
        Source code file supporting a threat.
        
        packageId (string) –
        
        The package identifier containing the evidence file.
        
        path (string) –
        
        The file path of the evidence.
    - stride (list) –
      
      The STRIDE categories applicable to this threat.
      - (string) –
        
        STRIDE threat classification category.
    - recommendation (string) –
      
      The recommended mitigation guidance for this threat.
    - createdBy (string) –
      
      Who created this threat.
    - updatedBy (string) –
      
      Who last updated this threat.
    - createdAt (datetime) –
      
      The date and time the threat was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the threat was last updated, in UTC format.
- notFound (list) –
  
  The list of threat identifiers that were not found.
  - (string) –