powershell-scripts/Audit PIM Role Activations and Deactivations/AuditPIMRoleActivations.ps1

<#
--------------------------------------------------------------------------------------------------------------------------
Name:        Audit PIM role activations and deactivations
Description: The script exports all PIM role activations and deactivations
Version:     1.0
Website:     o365reports.com

Script Highlights: 
~~~~~~~~~~~~~~~~~~
1.Supports generating report for PIM role activations only. 
2.Supports generating report for PIM role deactivations only. 
3.Automatically installs the Exchange Online PowerShell module (if not installed already) with your permission. 
4.Sends PIM role activation report via email to one or more recipients. 
5.Filters activity logs for a specific admin. 
6.Exports report in both HTML and CSV formats. 
7.Scheduler-friendly for automated PIM audits. 
8.Supports certificate-based authentication too.

For detailed script execution: https://o365reports.com/2025/07/15/audit-pim-role-activations-using-powershell/ 

------------------------------------------------------------------------------------------------------------------------------
#>

Param
(
    [Parameter(Mandatory = $false)]
    [Nullable[DateTime]]$StartDate,
    [Nullable[DateTime]]$EndDate,
    [string]$Recipients,
    [string]$FromAddress,
    [Switch]$PIMActivationsOnly,
    [Switch]$PIMDeactivationsOnly,
    [String]$PIMAdminName,
    [Switch]$HideSummaryAtEnd,
    [string]$Organization,
    [string]$ClientId,
    [string]$CertificateThumbprint,
    [string]$UserName,
    [string]$Password
)

Function Connect_Exo
{
 #Check for EXO module inatallation
 $Module = Get-Module ExchangeOnlineManagement -ListAvailable
 if($Module.count -eq 0) 
 { 
  Write-Host Exchange Online PowerShell module is not available  -ForegroundColor yellow  
  $Confirm= Read-Host Are you sure you want to install module? [Y] Yes [N] No 
  if($Confirm -match "[yY]") 
  { 
   Write-host "Installing Exchange Online PowerShell module"
   Install-Module ExchangeOnlineManagement -Repository PSGallery -AllowClobber -Force -Scope CurrentUser
   Import-Module ExchangeOnlineManagement
  } 
  else 
  { 
   Write-Host EXO module is required to connect Exchange Online.Please install module using Install-Module ExchangeOnlineManagement cmdlet. 
   Exit
  }
 } 
 Write-Host Connecting to Exchange Online...
 #Storing credential in script for scheduling purpose/ Passing credential as parameter - Authentication using non-MFA account
 if(($UserName -ne "") -and ($Password -ne ""))
 {
  $SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
  $Credential  = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword
  Connect-ExchangeOnline -Credential $Credential -ShowBanner:$false
 }
 elseif($Organization -ne "" -and $ClientId -ne "" -and $CertificateThumbprint -ne "")
 {
   Connect-ExchangeOnline -AppId $ClientId -CertificateThumbprint $CertificateThumbprint  -Organization $Organization -ShowBanner:$false
 }
 else
 {
  Connect-ExchangeOnline -ShowBanner:$false
 }
}

Function Connect_ToMgGraph 
{
 # Check if Microsoft Graph module is installed
 $MsGraphModule = Get-Module Microsoft.Graph -ListAvailable
 if ($MsGraphModule -eq $null) 
 {
  Write-Host "`nImportant: Microsoft Graph module is unavailable. It is mandatory to have this module installed in the system to run the script successfully." 
  $confirm = Read-Host "Are you sure you want to install Microsoft Graph module? [Y] Yes [N] No"
  if ($confirm -match "[y]") 
  {
   Write-Host "Installing Microsoft Graph module..."
   Install-Module Microsoft.Graph -Scope CurrentUser -AllowClobber
   Write-Host "Microsoft Graph module is installed in the machine successfully" -ForegroundColor Magenta 
  } 
  else 
  {
   Write-Host "Exiting. `nNote: Microsoft Graph module must be available in your system to run the script" -ForegroundColor Red
   Exit
  }
 } 
 Write-Host "`nConnecting to Microsoft Graph..."

 #Connect using certificate-based authentication
 if (($TenantId -ne "") -and ($ClientId -ne "") -and ($CertificateThumbprint -ne "")) 
 {
  Connect-MgGraph -TenantId $TenantId -AppId $ClientId -CertificateThumbprint $CertificateThumbprint -NoWelcome
 } 

 #Connect via interactive login
 else 
 {
  Connect-MgGraph -Scopes "Application.Read.All", "Mail.Send.Shared", "User.Read.All" -NoWelcome 
 }

 # Verify MS Graph session connection
 if ((Get-MgContext) -ne $null) 
 {
  if ((Get-MgContext).Account -ne $null) 
  {
   $Script:FromAddress= (Get-MgContext).Account
   Write-Host "Connected to Microsoft Graph PowerShell using account: $FromAddress"
  }
  else 
  {
   Write-Host "Connected to Microsoft Graph PowerShell using certificate-based authentication(CBA)."
   if (($Recipients -ne "") -and ([string]::IsNullOrEmpty($FromAddress))) 
   {
    Write-Host "`nError: FromAddress is required to send email when using CBA." -ForegroundColor Red
    Exit
   }
  }
 } 
 else 
 {
  Write-Host "Failed to connect to Microsoft Graph." -ForegroundColor Red
  Exit
 }
}

# Function to Send Email
Function SendEmail 
{
 #Recipients Address handling
 $EmailAddresses = ($Recipients -split ",").Trim()
 $ToRecipients = @()
 foreach ($Email in $EmailAddresses) {
  $ToRecipients += @{
   emailAddress = @{
    address = $Email
   }
  }
 }

 #Get the content from GTML report to place in email body
 $HtmlTable = Get-Content -Path $OutputHTML -Raw

 # Read the table file as attachment content
# $FileBytes = [System.IO.File]::ReadAllBytes($OutputHTML)         Uncomment to send the report as email attachment
# $Base64Content = [System.Convert]::ToBase64String($FileBytes)    Uncomment to send the report as email attachment

  $EmailBody = @"
 <html>
  <head>
    <meta charset='UTF-8'>
  </head>
  <body>
    <p>Hello Admin,</p>
    <p>Here is the PIM role activation/deactivation report for the period $StartDate to $EndDate.</p>

    $HtmlTable

    <p>If you notice any unusual activity or need to investigate a specific entry, please follow up via 
    <a href='https://entra.microsoft.com/#view/Microsoft_AAD_IAM/AuditLogList.ReactView' target='_blank'>Entra audit log</a>.</p>  

    <p>If you have any questions, feel free to contact IT support.</p>  
    <p>Best regards,<br>IT Admin Team</p>
  </body>
 </html>
"@

 $params = @{
        Message = @{
            Subject = "PIM Role Activation Report"
            Body = @{
                ContentType = "HTML"
                Content     = $EmailBody
            }
            #Uncomment to send the report as email attachment
      <#      Attachments = @(
            @{
                "@odata.type" = "#microsoft.graph.fileAttachment"
                Name          = "PIM_Role_Activation_Report.html"
                ContentBytes  = $Base64Content
                ContentType   = "text/html"
            }
        ) #>  
            ToRecipients = $ToRecipients
        }
        SaveToSentItems = $true
    }
 Send-MgUserMail -UserId $Script:FromAddress -BodyParameter $params
}

Function HTML_Style
{
 # Start HTML with style and opening tags
 $Header = @"
 <html>
  <head>
    <meta charset="UTF-8">
    <style>
        table { width: 100%; border-collapse: collapse; font-family: Arial, sans-serif; }
        th, td { border: 1px solid black; padding: 8px; text-align: left; }
        th { background-color: #f2f2f2; }
    </style>
  </head>
 <body>
  <h2>PIM Role Activation Report</h2>

  <table>
  <tr><th>Event Time</th><th>Operation</th><th>Admin Name</th><th>PIM Role</th><th>More Info</th></tr>
"@

 # Write the header once
 $Header | Out-File -FilePath $OutputHTML -Encoding UTF8
}

$MaxStartDate=((Get-Date).AddDays(-179)).Date


#Retrieving Audit log for the past 180 days
if(($StartDate -eq $null) -and ($EndDate -eq $null))
{
 $EndDate=(Get-Date).Date
 $StartDate=$MaxStartDate
}
#Getting start date for audit report
While($true)
{
 if ($StartDate -eq $null)
 {
  $StartDate=Read-Host Enter start time for report generation '(Eg:12/15/2023)'
 }
 Try
 {
  $Date=[DateTime]$StartDate
  if($Date -ge $MaxStartDate)
  { 
   break
  }
  else
  {
   Write-Host `nAudit can be retrieved only for the past 180 days. Please select a date after $MaxStartDate -ForegroundColor Red
   return
  }
 }
 Catch
 {
  Write-Host `nNot a valid date -ForegroundColor Red
 }
}


#Getting end date to retrieve audit log
While($true)
{
 if ($EndDate -eq $null)
 {
  $EndDate=Read-Host Enter End time for report generation '(Eg: 12/15/2023)'
 }
 Try
 {
  $Date=[DateTime]$EndDate
  if($EndDate -lt ($StartDate))
  {
   Write-Host End time should be later than start time -ForegroundColor Red
   return
  }
  break
 }
 Catch
 {
  Write-Host `nNot a valid date -ForegroundColor Red
 }
}
$Location=Get-Location
$OutputCSV="$Location\Audit_PIM_Role_Activations$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv" 
$OutputHTML="$Location\Audit_PIM_Role_Activations$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).html" 
$IntervalTimeInMinutes=1440    #$IntervalTimeInMinutes=Read-Host Enter interval time period '(in minutes)'
$CurrentStart=$StartDate
$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes)
HTML_Style
#Check whether CurrentEnd exceeds EndDate
if($CurrentEnd -gt $EndDate)
{
 $CurrentEnd=$EndDate
}

if($CurrentStart -eq $CurrentEnd)
{
 Write-Host Start and end time are same.Please enter different time range -ForegroundColor Red
 Exit
}

Connect_EXO
if($Recipients -ne "")
{
 Connect_ToMgGraph 
}
$AggregateResults = @()
$CurrentResult= @()
$CurrentResultCount=0
$AggregateResultCount=0
$ProgressCount=0
$OutputEvents=0
Write-Host `nRetrieving Role activation and deactivation audit log from $StartDate to $EndDate... -ForegroundColor Yellow
$ExportResult=""   
$ExportResults=@()  

if($PIMActivationsOnly.IsPresent)
{
 $Operations="Add member to role"
}
elseif($PIMDeactivationsOnly.IsPresent)
{
 $Operations="Remove member from role"
}
else
{
 $Operations="Add member to role,Remove member from role"
}


while($true)
{ 
 #Getting audit data for the given time range
 $Results=Search-UnifiedAuditLog -StartDate $CurrentStart -EndDate $CurrentEnd -Operations $Operations -SessionId s -SessionCommand ReturnLargeSet -ResultSize 5000
 $ResultCount=($Results | Measure-Object).count
 $AllAuditData=@()
 foreach($Result in $Results)
 {
  $ProgressCount++
  $MoreInfo=$Result.auditdata
  $AuditData=$Result.auditdata | ConvertFrom-Json
  $ActivityTime=(Get-Date($AuditData.CreationTime)).ToLocalTime()  #Get-Date($AuditData.CreationTime) Uncomment to view the Activity Time in UTC
  $Operation=$AuditData.operation
  $ResultStatus=$AuditData.ResultStatus
  $ModifiedProperties=$AuditData.ModifiedProperties
  $ActorInfo= $AuditData.Actor 
  $ActorName=$ActorInfo.ID[0]
  $AdminName=$AuditData.ObjectId

  #Filter whether it's PIM operation or not
  if($ActorName -eq "MS-PIM")
  {
   if($Operation -eq "Remove member from role.")
   {
    $Event="PIM Deactivation"
    $RoleName= $ModifiedProperties | Where-Object { $_.Name -eq "Role.DisplayName" } | Select-Object -ExpandProperty OldValue
   }

   if($Operation -eq "Add member to role.")
   {
    $Event="PIM Activation"
    $RoleName= $ModifiedProperties | Where-Object { $_.Name -eq "Role.DisplayName" } | Select-Object -ExpandProperty NewValue
   }
  }
  else
  {
   Continue
  }

  #Admin based filter
  if($PIMAdminName -ne "" -and ($PIMAdminName -ne $AdminName))
  {
   continue
  }


  #Export result to csv

  $OutputEvents++
  $ExportResult=@{'Event Time'=$ActivityTime;'Operation'=$Event;'Admin Name'=$AdminName;'PIM Role'=$RoleName;'Performed By'=$ActorName;'More Info'=$MoreInfo}
  $ExportResults= New-Object PSObject -Property $ExportResult  
  $ExportResults | Select-Object 'Event Time','Operation','Admin Name','PIM Role','More Info' | Export-Csv -Path $OutputCSV -Notype -Append 
  
  #Export result to HTML
  $HTMLResult= "<tr><td>$($ActivityTime)</td><td>$($Event)</td><td>$($AdminName)</td><td>$($RoleName)</td><td>$($MoreInfo)</td></tr>"
  $HTMLResult | Out-File -FilePath $OutputHTML -Append -Encoding UTF8
 }

 Write-Progress -Activity "`n     Retrieving PIM activation and deactivation audit data from $StartDate to $EndDate.."`n" Processed audit record count: $ProgressCount"
 $currentResultCount=$CurrentResultCount+$ResultCount
 
 if($CurrentResultCount -ge 50000)
 {
  Write-Host Retrieved max record for current range.Proceeding further may cause data loss or rerun the script with reduced time interval. -ForegroundColor Red
  $Confirm=Read-Host `nAre you sure you want to continue? [Y] Yes [N] No
  if($Confirm -match "[Y]")
  {
   Write-Host Proceeding audit log collection with data loss
   [DateTime]$CurrentStart=$CurrentEnd
   [DateTime]$CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes)
   $CurrentResultCount=0
   if($CurrentEnd -gt $EndDate)
   {
    $CurrentEnd=$EndDate
   }
  }
  else
  {
   Write-Host Please rerun the script with reduced time interval -ForegroundColor Red
   Exit
  }
 }
 
 if($ResultCount -lt 5000)
 { 
  if($CurrentEnd -eq $EndDate)
  {
   break
  }
  $CurrentStart=$CurrentEnd 
  if($CurrentStart -gt (Get-Date))
  {
   break
  }
  $CurrentEnd=$CurrentStart.AddMinutes($IntervalTimeInMinutes)
  $CurrentResultCount=0
  if($CurrentEnd -gt $EndDate)
  {
   $CurrentEnd=$EndDate
  }
 }                                                                                             
 $ResultCount=0
}

@"
</table>
</body>
</html>
"@ | Out-File -FilePath $OutputHTML -Append -Encoding UTF8

#Send report via email
if(($Recipients -ne "") -and ($OutputEvents -ne 0))
{
  SendEmail
}

Write-Host `n~~ Script prepared by AdminDroid Community ~~`n -ForegroundColor Green
Write-Host "~~ Check out " -NoNewline -ForegroundColor Green; Write-Host "admindroid.com" -ForegroundColor Yellow -NoNewline; Write-Host " to get access to 1800+ Microsoft 365 reports. ~~" -ForegroundColor Green `n`n


#Open output file after execution
if(!($HideSummaryAtEnd))
{
 If($OutputEvents -eq 0)
 {
  Write-Host No records found
 }
 else
 {
  Write-Host `nThe output file contains $OutputEvents audit records
  if((Test-Path -Path $OutputCSV) -eq "True") 
  {
   Write-Host `n "The Output file availble in:" -NoNewline -ForegroundColor Yellow
    Write-Host CSV format: "$OutputCSV" `n 
    Write-Host HTML format: $OutputHTML
   $Prompt = New-Object -ComObject wscript.shell   
  $UserInput = $Prompt.popup("Do you want to open output file?",`   
 0,"Open Output File",4)   
   If ($UserInput -eq 6)   
   {   
    Invoke-Item "$OutputCSV"   
    Invoke-Item $OutputHTML
   } 
  }
 }
}

#Disconnect Exchange Online session
Disconnect-ExchangeOnline -Confirm:$false -InformationAction Ignore -ErrorAction SilentlyContinue
#Disconnect MS Graph session
Disconnect-MgGraph | Out-Null