# jamf/ms-security-copilot-plugin architecture

> Architecture diagram of the GitHub repository jamf/ms-security-copilot-plugin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jamf/ms-security-copilot-plugin
- Repository: https://github.com/jamf/ms-security-copilot-plugin

## Overview

##### Main Components
- Microsoft Security Copilot Plugin: Represent this as the external consumer that uses the API.
- Jamf Pro: This is the target system exposing the API endpoints.
- API Layer: Based on the api-spec.yaml, this layer defines the endpoints, operations, input/output data, and authentication mechanisms used to connect the plugin to Jamf Pro.
- Metadata/Documentation: Use the catalog-info.yaml as a supporting component, noticing that it provides supplementary documentation / catalog reference for the API spec.

##### Their Relationships and Interactions
- API Layer interacting bidirectionally with the Jamf Pro system—it receives calls from, and sends responses back to, the plugin.

##### Architectural Patterns and Design Principles
- Separation of concerns: the plugin (client) and Jamf Pro (server) interact purely via RESTful HTTP(S) requests as defined by the OpenAPI specification.
- The API spec is the contract ensuring that both sides know what to expect regarding endpoints, parameters, and responses.
- This “API-first” approach is central to the design and integration of the two systems.

##### Relevant Technologies and Frameworks
- While the repo does not include actual implementation code, note that the OpenAPI specification implies the use of standard RESTful practices.

- Clear labels for each component (Microsoft Security Copilot Plugin, API Spec Layer, Jamf Pro, Documentation/Metadata).

## Diagram (Mermaid)

```mermaid
flowchart TD
    Plugin["Microsoft Security Copilot Plugin"]:::plugin
    API["API Spec Layer"]:::api
    Jamf["Jamf Pro"]:::jamf
    Doc["Documentation/Metadata"]:::doc

    Plugin -->|"sends_request"| API
    API -->|"forwards_request"| Jamf
    Doc -->|"provides_metadata"| API

    click API "https://github.com/jamf/ms-security-copilot-plugin/blob/main/api-spec.yaml"
    click Doc "https://github.com/jamf/ms-security-copilot-plugin/blob/main/catalog-info.yaml"

    classDef plugin fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef api fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef jamf fill:#FFA500,stroke:#000,stroke-width:2px;
    classDef doc fill:#DDA0DD,stroke:#000,stroke-width:2px;
```
