🔍 Code Extractor

class SimulationReport_v1

Maturity: 35

A data class representing an overview report of an attack simulation and training campaign, inheriting from ClientValue for Office 365 API integration.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/report_overview.py
Lines:
4 - 5
Complexity:
simple

Purpose

This class serves as a data transfer object (DTO) to encapsulate overview report information for attack simulation and training campaigns within the Office 365 ecosystem. It inherits from ClientValue, which provides serialization/deserialization capabilities for communication with Microsoft Graph API endpoints. The class is designed to hold structured data about simulation campaigns, including metrics, results, and summary information that can be transmitted between client and server.

Source Code

class SimulationReportOverview(ClientValue):
    """Represents an overview report of an attack simulation and training campaign."""

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Inherits from ClientValue, which is a base class from the office365 runtime that provides client-side value object functionality for API communication, including JSON serialization and property mapping

Return Value

Instantiation returns a SimulationReportOverview object that can store and transport attack simulation campaign overview data. The object inherits ClientValue's capabilities for property access and serialization to/from JSON for API communication.

Class Interface

Methods

__init__(self)

Purpose: Initializes a new instance of SimulationReportOverview, inheriting initialization from ClientValue base class

Returns: None - constructor initializes the object instance

Attributes

Name Type Description Scope
entity_type_name str Inherited from ClientValue - stores the entity type name for API serialization, likely 'microsoft.graph.simulationReportOverview' instance

Dependencies

  • office365-runtime

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.security.simulation_report_overview import SimulationReportOverview

# Instantiate the overview report object
report_overview = SimulationReportOverview()

# Typically used in conjunction with Microsoft Graph API calls
# The object would be populated from API responses or used to send data
# Example: Receiving data from API
# report_overview = client.security.attack_simulation.get_overview().execute_query()

# Access properties (inherited from ClientValue)
# Properties would be defined in the actual implementation
# print(report_overview.to_json())

Best Practices

  • This class is typically instantiated automatically by the Office 365 SDK when deserializing API responses rather than manually created
  • Use in conjunction with Office 365 client context and proper authentication mechanisms
  • The class inherits property management from ClientValue, so properties are likely defined dynamically or in the parent class
  • Do not modify internal state directly; use provided methods or properties from the ClientValue base class
  • Ensure proper error handling when working with API responses that populate this object
  • This is a value object and should be treated as immutable once populated from API responses

Tags

security attack-simulation training-campaign office365 microsoft-graph data-transfer-object dto client-value report overview

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SimulationReport 90.7% similar

    A data class representing a report of an attack simulation and training campaign, containing an overview and information about participating users.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/report.py

  • class AttackSimulationSimulationUserCoverage 78.8% similar

    A data class representing cumulative simulation data and results for a user in Microsoft 365 attack simulation and training scenarios.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/user_coverage.py

  • class Simulation 69.3% similar

    Represents an attack simulation training campaign in Microsoft Defender for Office 365, providing access to phishing simulation exercises and training reports.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/simulation.py

  • class AttackSimulationRepeatOffender 68.9% similar

    A data model class representing a user in a Microsoft 365 tenant who has repeatedly fallen victim to simulated phishing attacks and security training campaigns.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/repeat_offender.py

  • class SimulationAutomationRun 65.1% similar

    A class representing a run of an attack simulation automation on a Microsoft 365 tenant, inheriting from the Entity base class.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/security/attacksimulations/automation_run.py
← Back to Browse