# super50nic/ad_scripts architecture

> Architecture diagram of the GitHub repository super50nic/ad_scripts, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/super50nic/ad_scripts
- Repository: https://github.com/super50nic/ad_scripts

## Overview

##### Project type and purpose
- This is an open-source PowerShell utility consisting of two scripts (`groupmemership_md.ps1` and `department.ps1`) plus a `README.md`.
- Its primary function is to query Active Directory for a user’s group memberships (recursively), then emit a structured Markdown report.

##### File structure
- Top level:
- README.md – project overview and instructions
- groupmemership_md.ps1 – main script to generate group-membership markdown
- department.ps1 – (presumably) a helper or related AD-department lookup script
- No web frontend or database tier; this is a standalone CLI tool that depends on the Windows PowerShell runtime and the Active Directory module.

##### Key architectural elements from README
- PowerShell host (engine) with Admin privilege
- Active Directory Module (imported at runtime)
- Recursive function `Get-RecursiveGroupMembership` (tracks visited groups)
- Prompt for SAM account name (user input)
- Output writer that serializes data to Markdown in `C:\TEMP`
- Error handling and logging for missing groups/users

##### Main components
a. User (Administrator)
b. PowerShell Runtime (host)
c. Scripts:
- groupmemership_md.ps1 (core logic)
- department.ps1 (auxiliary functionality)
d. AD Module (cmdlets: Get-ADUser / Get-ADGroup / recursive lookup)
e. Recursive-lookup engine (function)
f. File System (C:\TEMP directory)
g. Output Markdown file

##### Relationships and data flow
1. Administrator invokes `groupmemership_md.ps1` in PowerShell.
2. Script imports the AD module.
3. Script prompts for SAMAccountName → administrator inputs name.
4. Script calls `Get-RecursiveGroupMembership`, which:
– Queries AD via module cmdlets
– Recurses up the group hierarchy, tracking visited groups
– Returns a hierarchical data structure of group names + descriptions
5. Script serializes the hierarchy to Markdown.
6. Script writes `[SAMAccountName].md` to `C:\TEMP`.
7. Errors/warnings for missing objects are logged to console.

##### Architectural patterns and design principles
- Single-responsibility: main script handles orchestration; recursion is factored into its own function.
- Defensive programming: visited-groups tracking avoids infinite loops; error handling via try/catch.
- Extensibility: additional scripts (e.g., `department.ps1`) can be plugged in or modified without altering core logic.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Entities
    User["Administrator"]:::user
    PS["PowerShell Host"]:::env
    ADMod["Active Directory Module"]:::dependency
    Scripts["Scripts"]:::group

    subgraph "Script Execution"
        GMS["groupmemership_md.ps1"]:::script
        DEP["department.ps1"]:::script
        Func["Get-RecursiveGroupMembership()"]:::function
    end

    FS["File System: C:\\TEMP"]:::fs
    Console["Console / Log"]:::log
    Doc["README.md"]:::doc

    %% Flow
    User -->|"invoke script"| PS
    PS -->|"loads module"| ADMod
    PS -->|"executes"| GMS
    GMS -->|"imports"| ADMod
    GMS -->|"prompts for SAMAccountName"| User
    GMS -->|"calls"| Func
    Func -->|"queries cmdlets"| ADMod
    Func -->|"returns hierarchy"| GMS
    GMS -->|"serializes hierarchy"| FS
    GMS -->|"writes [SAMAccountName].md"| FS
    GMS -->|"on error"| Console
    GMS -->|"can invoke"| DEP
    PS -->|"references docs"| Doc

    %% Click events
    click GMS "https://github.com/super50nic/ad_scripts/blob/main/groupmemership_md.ps1"
    click DEP "https://github.com/super50nic/ad_scripts/blob/main/department.ps1"
    click Doc "https://github.com/super50nic/ad_scripts/blob/main/README.md"

    %% Styles
    classDef user fill:#E3F2FD,stroke:#90CAF9,color:#0D47A1;
    classDef env fill:#E8F5E9,stroke:#66BB6A,color:#1B5E20;
    classDef dependency fill:#FFF3E0,stroke:#FFA726,color:#E65100;
    classDef script fill:#F3E5F5,stroke:#AB47BC,color:#4A148C;
    classDef function fill:#E1F5FE,stroke:#29B6F6,color:#01579B;
    classDef fs fill:#EFEBE9,stroke:#8D6E63,color:#3E2723;
    classDef log fill:#FFEBEE,stroke:#E57373,color:#B71C1C;
    classDef doc fill:#FFFDE7,stroke:#FFEE58,color:#F57F17;
    class Scripts grouppping:inline;
```
