🔍 Code Extractor

class AttackSimulationSimulationUserCoverage

Maturity: 37

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

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

Purpose

This class serves as a data transfer object (DTO) that encapsulates user-specific metrics and coverage information from attack simulation exercises. It inherits from ClientValue, which is part of the Office 365 Python SDK framework for representing client-side values that can be serialized/deserialized when communicating with Microsoft Graph API endpoints. The class is used to track and report on user participation and performance in security training simulations.

Source Code

class AttackSimulationSimulationUserCoverage(ClientValue):
    """Represents cumulative simulation data and results for a user in attack simulation and training."""

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Inherits from ClientValue, which provides base functionality for client-side value objects in the Office 365 SDK, including serialization/deserialization capabilities for API communication

Return Value

Instantiation returns an AttackSimulationSimulationUserCoverage object that can hold user simulation coverage data. As a ClientValue subclass, instances can be serialized to JSON for API requests and deserialized from API responses.

Class Interface

Methods

__init__()

Purpose: Initializes a new instance of AttackSimulationSimulationUserCoverage

Returns: None - constructor initializes the object

Attributes

Name Type Description Scope
entity_type_name str Inherited from ClientValue, stores the entity type name for serialization purposes instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.entity.attacksimulation_simulation_user_coverage import AttackSimulationSimulationUserCoverage

Usage Example

from office365.runtime.client_value import ClientValue
from office365.entity.attacksimulation_simulation_user_coverage import AttackSimulationSimulationUserCoverage

# Typically instantiated by the Office 365 SDK when retrieving data
user_coverage = AttackSimulationSimulationUserCoverage()

# The object would normally be populated by API response data
# and accessed through the Office 365 client context
# Example: retrieving from Microsoft Graph API
# context = ClientContext(tenant_url).with_credentials(credentials)
# coverage_data = context.security.attack_simulation.simulation_user_coverage.get().execute_query()
# for user_coverage in coverage_data:
#     # Access user coverage properties
#     pass

Best Practices

  • This class is typically instantiated and populated by the Office 365 SDK framework rather than manually by developers
  • Instances are usually obtained through Microsoft Graph API queries for attack simulation data
  • As a ClientValue subclass, the object supports property-based access to simulation data fields
  • Do not manually construct instances unless extending the SDK or testing; rely on API responses to populate objects
  • The class follows the Office 365 SDK pattern where properties are dynamically added based on API response structure
  • Ensure proper authentication and authorization before attempting to access attack simulation data
  • This is a read-only data structure representing API response data; modifications should be done through appropriate API endpoints

Tags

security attack-simulation training microsoft-365 office365 data-transfer-object dto client-value user-coverage simulation-metrics

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SimulationReport_v1 78.8% similar

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

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

  • class AttackSimulationRepeatOffender 77.3% 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 SimulationReport 75.8% 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 SimulationAutomationRun 69.3% 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

  • class Simulation 68.7% 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
← Back to Browse