Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions engine/collectors/entra/users/admin_license_footprint.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
"""Admin license footprint collector.

CIS Microsoft 365 Foundations Benchmark Controls:
v6.0.0: 1.1.4

Connection Method: Microsoft Graph API
Required Scopes: Directory.Read.All, User.Read.All
Graph Endpoints: /directoryRoles, /directoryRoles/{id}/members, /users/{id}, /subscribedSkus
"""

from __future__ import annotations

from typing import Any

from collectors.base import BaseDataCollector
from collectors.graph_client import GraphClient


class AdminLicenseFootprintDataCollector(BaseDataCollector):
"""Collects license assignments for administrative accounts.

This collector identifies users with directory roles (admin accounts),
fetches their assigned licenses, and maps SKU IDs to SKU part numbers.
"""

async def collect(self, client: GraphClient) -> dict[str, Any]:
# Fetch directory roles and members
roles = await client.get_directory_roles()

admin_users: dict[str, dict[str, Any]] = {}
for role in roles:
role_id = role.get("id")
role_name = role.get("displayName")
if not role_id:
continue

members = await client.get_role_members(role_id)
for member in members:
if member.get("@odata.type") != "#microsoft.graph.user":
continue
Comment on lines +37 to +40

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Include users assigned admin roles via groups

This collector only processes members whose @odata.type is #microsoft.graph.user, so if a directory role is assigned to a group, all users in that group are skipped. In tenants that use group-based role assignments (common for admin roles), the output undercounts admin accounts and therefore misses their license assignments. Consider expanding group membership (e.g., via /transitiveMembers) or resolving group members before building admin_users.

Useful? React with 👍 / 👎.

user_id = member.get("id")
if not user_id:
continue

entry = admin_users.setdefault(
user_id,
{
"id": user_id,
"displayName": member.get("displayName"),
"userPrincipalName": member.get("userPrincipalName"),
"roles": [],
},
)
entry["roles"].append(role_name)

# Map SKU IDs to readable names
sku_response = await client.get("/subscribedSkus")
sku_map = {
sku.get("skuId"): {
"skuPartNumber": sku.get("skuPartNumber"),
"prepaidUnits": sku.get("prepaidUnits"),
}
for sku in sku_response.get("value", [])
if sku.get("skuId")
}

admin_license_details: list[dict[str, Any]] = []
for user_id, info in admin_users.items():
user_detail = await client.get(
f"/users/{user_id}",
params={
"$select": "id,displayName,userPrincipalName,assignedLicenses,accountEnabled",
},
)
assigned = user_detail.get("assignedLicenses", [])
license_skus = [lic.get("skuId") for lic in assigned if lic.get("skuId")]

admin_license_details.append(
{
"id": user_id,
"displayName": info.get("displayName") or user_detail.get("displayName"),
"userPrincipalName": info.get("userPrincipalName")
or user_detail.get("userPrincipalName"),
"accountEnabled": user_detail.get("accountEnabled"),
"roles": info.get("roles", []),
"assignedLicenses": assigned,
"assignedSkuIds": license_skus,
}
)

return {
"admin_users_count": len(admin_users),
"admin_users": admin_license_details,
"sku_map": sku_map,
}
4 changes: 4 additions & 0 deletions engine/collectors/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@
from collectors.entra.roles.cloud_only_admins import CloudOnlyAdminsDataCollector
from collectors.entra.roles.directory_roles import DirectoryRolesDataCollector
from collectors.entra.roles.privileged_roles import PrivilegedRolesDataCollector
from collectors.entra.users.admin_license_footprint import (
AdminLicenseFootprintDataCollector,
)

# Users
from collectors.entra.users.users import UsersDataCollector
Expand Down Expand Up @@ -188,6 +191,7 @@
"entra.roles.directory_roles": DirectoryRolesDataCollector,
"entra.roles.privileged_roles": PrivilegedRolesDataCollector,
# Users
"entra.users.admin_license_footprint": AdminLicenseFootprintDataCollector,
"entra.users.users": UsersDataCollector,
# Exchange - DNS
"exchange.dns.dns_security_records": DnsSecurityRecordsDataCollector,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@
"level": "L1",
"is_manual": false,
"benchmark_audit_type": "Automated",
"automation_status": "not_started",
"data_collector_id": null,
"automation_status": "ready",
"data_collector_id": "entra.users.admin_license_footprint",
"policy_file": null,
"requires_permissions": null,
"notes": "Need to check user license assignments"
"requires_permissions": ["Directory.Read.All", "User.Read.All"],
"notes": "Collect admin users and their assigned licenses"
},
{
"control_id": "1.2.1",
Expand All @@ -91,7 +91,7 @@
"level": "L1",
"is_manual": false,
"benchmark_audit_type": "Automated",
"automation_status": "not_started",
"automation_status": "ready",
"data_collector_id": "exchange.mailbox.mailboxes",
"policy_file": null,
"requires_permissions": ["Exchange.Manage"],
Expand Down Expand Up @@ -811,11 +811,11 @@
"level": "L1",
"is_manual": false,
"benchmark_audit_type": "Automated",
"automation_status": "not_started",
"data_collector_id": null,
"automation_status": "ready",
"data_collector_id": "entra.devices.device_registration_policy",
"policy_file": null,
"requires_permissions": null,
"notes": "Need LAPS configuration collector"
"requires_permissions": ["Policy.Read.DeviceConfiguration"],
"notes": "Uses deviceRegistrationPolicy localAdminPassword.isEnabled for LAPS state"
},
{
"control_id": "5.1.4.6",
Expand Down
Loading