https://github.com/M365-Consultant/EntraID-Group-Cleanup

This script is designed for an Azure Runbook to automatically remove users from an EntraID (AzureAD) group, based on the time of membership (max.30 days).
https://github.com/M365-Consultant/EntraID-Group-Cleanup

Last synced: 3 months ago
JSON representation

This script is designed for an Azure Runbook to automatically remove users from an EntraID (AzureAD) group, based on the time of membership (max.30 days).

• Host: GitHub
• URL: https://github.com/M365-Consultant/EntraID-Group-Cleanup
• Owner: M365-Consultant
• License: mit
• Created: 2023-10-01T12:02:18.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-23T11:17:02.000Z (about 1 year ago)
• Last Synced: 2024-06-24T23:37:22.655Z (5 months ago)
• Language: PowerShell
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-entra - EntraID-Group-Cleanup - Azure Runbook to automatically remove users from a group based on time of membership (e.g. 30 days). [](https://badgen.net/github/stars/M365-Consultant/EntraID-MFA-DynamicGroup) (Tools / Log Analytics, KQL, Logic Apps...)

README

        
*** WORK IN PROGRESS ***

# EntraID-Group-Cleanup

This script is designed for an Azure Runbook to automatically remove users from an EntraID (AzureAD) group, based on the time of membership.

Please note that this script relies on the Audit Log to retrieve the timestamp of a user's addition to a group. As a result, the maximum timeframe available is determined by the retention period set for your Audit Log!

# Requirements

Before running the runbook, you need to set up an automation account with a managed identity.

The managed identity requires the following Graph Permissions:

   - User.Read.All

   - AuditLog.Read.All

   - Group.ReadWrite.All

   - Mail.Send

The script requires the following modules:

   - Microsoft.Graph.Authentication

   - Microsoft.Graph.Groups

   - Microsoft.Graph.Reports

   - Microsoft.Graph.Users

   - Microsoft.Graph.Users.Actions

# Parameters

There are a few parameters which must be set for a job run:

- $groupid_capable

  - The Object-ID of a EntraID (AzureAD) group

- $timeCleanup 

  - The time in MINUTES, for how long a user should remain in the group (maximum is your Audit-Log retention!)

- $mailMode -> This controls the mail behavior. Enter the mode you want without using '

  - 'always' - sends a mail on every run

  - 'removal' - sends a mail only if a user has been removed from the group

  - 'members' - sends a mail aslong as there are members in the group

  - 'disabled' - never send a mail

- $mailSender

  - The mail-alias from which the mail will be send (can be a user-account or a shared-mailbox)

- $mailRecipients

  - The recipient(s) of the mail (internal or external). If you want more than one recipient, you can separate them with the character ; in between.

# Changelog

- v0.3 Fixed the error with the mail-mode "removal" and implemented the option "members" (see description)

- v0.2b Small changes on the Email-Reporting

- v0.2 Email-Reporting optimization

  - Multiple optimizations on the e-mail content.

  - Fixed false naming in the description

- v0.1 First release

  - First release of this script