From dbff9a3c801fd3a858a4795df342580475abc224 Mon Sep 17 00:00:00 2001
From: AdminDroid <49208841+admindroid-community@users.noreply.github.com>
Date: Tue, 25 Apr 2023 13:00:34 +0530
Subject: [PATCH] Get Guest User Report with MS Graph PowerShell

Get Guest User Report with MS Graph PowerShell
---
 Guest User Report/GuestUserReport.ps1 | 201 ++++++++++++--------------
 1 file changed, 95 insertions(+), 106 deletions(-)

diff --git a/Guest User Report/GuestUserReport.ps1 b/Guest User Report/GuestUserReport.ps1
index e8be4ab..076ba6b 100644
--- a/Guest User Report/GuestUserReport.ps1	
+++ b/Guest User Report/GuestUserReport.ps1	
@@ -1,126 +1,115 @@
-#Accept input parameter
+<#
+=============================================================================================
+Name:           Export Office 365 Guest user and their membership report using MS Graph PowerShell
+Version:        3.0
+Website:        o365reports.com
+For detailed Script execution: https://o365reports.com/2020/11/12/export-office-365-guest-user-report-with-their-membership/
+============================================================================================
+#>
+#Accept input parameter
 Param
 (
     [Parameter(Mandatory = $false)]
     [int]$StaleGuests,
     [int]$RecentlyCreatedGuests,
-    [string]$UserName,
-    [string]$Password
-    
+    [string]$TenantId,
+    [string]$ClientId,
+    [string]$CertificateThumbprint
 )
 
-#Check for AzureAD module
-$Module=Get-Module -Name AzureAD -ListAvailable  
-if($Module.count -eq 0) 
+$MsGraphModule =  Get-Module Microsoft.Graph -ListAvailable
+if($MsGraphModule -eq $null)
 { 
- Write-Host AzureAD 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]") 
- { 
-  Install-Module AzureAD
-  Import-Module AzureAD
- } 
- else 
- { 
-  Write-Host AzureAD module is required to connect AzureAD.Please install module using Install-Module AzureAD cmdlet. 
-  Exit
- }
-} 
- 
-Write-Host Connecting Azure AD... -ForegroundColor Yellow
-#Storing credential in script for scheduling purpose/ Passing credential as parameter  
-if(($UserName -ne "") -and ($Password -ne ""))  
+    Write-host "Important: 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 "[yY]") 
+    { 
+        Write-host "Installing Microsoft graph module..."
+        Install-Module Microsoft.Graph -Scope CurrentUser
+        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 
+    } 
+}
+if(($TenantId -ne "") -and ($ClientId -ne "") -and ($CertificateThumbprint -ne ""))  
 {  
- $SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force  
- $Credential  = New-Object System.Management.Automation.PSCredential $UserName,$SecuredPassword  
- Connect-AzureAD -Credential $credential | Out-Null
-}  
-else  
-{  
- Connect-AzureAD | Out-Null  
-} 
-
+    Connect-MgGraph  -TenantId $TenantId -AppId $ClientId -CertificateThumbprint $CertificateThumbprint -ErrorAction SilentlyContinue -ErrorVariable ConnectionError|Out-Null
+    if($ConnectionError -ne $null)
+    {    
+        Write-Host $ConnectionError -Foregroundcolor Red
+        Exit
+    }
+}
+else
+{
+    Connect-MgGraph -Scopes "Directory.Read.All"  -ErrorAction SilentlyContinue -Errorvariable ConnectionError |Out-Null
+    if($ConnectionError -ne $null)
+    {
+        Write-Host "$ConnectionError" -Foregroundcolor Red
+        Exit
+    }
+}
+Write-Host "Microsoft Graph Powershell module is connected successfully" -ForegroundColor Green
+Select-MgProfile beta
 $Result=""   
-$Results=@()  
 $GuestCount=0
 $PrintedGuests=0
 
 #Output file declaration 
-$ExportCSV=".\GuestUserReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm` tt).ToString()).csv"
+$ExportCSV=".\GuestUserReport_$((Get-Date -format yyyy-MMM-dd-ddd` hh-mm-ss` tt).ToString()).csv"
 Write-Host `nExporting report... 
 #Getting guest users
-Get-AzureADUser -All $true -Filter "UserType eq 'Guest'" | foreach {
- $DisplayName=$_.DisplayName
- $Upn=$_.UserPrincipalName
- $GuestCount++
- Write-Progress -Activity "`n     Processed mailbox count: $GuestCount "`n"  Currently Processing: $DisplayName"
- $GetCreationTime=$_.ExtensionProperty
- $CreationTime=$GetCreationTime.createdDateTime 
- $AccountAge= (New-TimeSpan -Start $CreationTime).Days
+Get-MgUser -All -Filter "UserType eq 'Guest'" -ExpandProperty MemberOf  | foreach {
+    $DisplayName = $_.DisplayName
+    $GuestCount++
+    Write-Progress -Activity "`n     Processed mailbox count: $GuestCount "`n"  Currently Processing: $DisplayName"
+    $AccountAge = (New-TimeSpan -Start $_.CreatedDateTime).Days
 
- #Check for stale guest users
- if(($StaleGuests -ne "") -and ([int]$AccountAge -lt $StaleGuests)) 
- { 
-  return
- }
+    #Check for stale guest users
+    if(($StaleGuests -ne "") -and ([int]$AccountAge -lt $StaleGuests)) 
+    { 
+        return
+    }
 
- #Check for recently created guest users
- if(($RecentlyCreatedGuests -ne "") -and ([int]$AccountAge -gt $RecentlyCreatedGuests)) 
- { 
-  return
- }
-
- $ObjectId=$_.ObjectId
- $Mail=$_.Mail
- $Company=$_.CompanyName
- if($Company -eq $null)
- {
-  $Company="-"
- }
- $CreationType=$_.CreationType
- $InvitationAccepted=$_.UserState
-
- #Getting guest user's group membership
- $Groups=(Get-AzureADUserMembership -ObjectId $ObjectId).DisplayName
- #$Groups
- $GroupMembership=""
- foreach($Group in $Groups)
- {
-  #$Group
-  if($GroupMembership -ne "")
-  {
-   $GroupMembership=$GroupMembership+","
-  }
-  $GroupMembership=$GroupMembership+$Group
- }
- if($GroupMembership -eq "")
- {
-  $GroupMembership="-"
- }
- 
-
- #Export result to CSV file 
- $PrintedGuests++
- $Result=@{'UserPrincipalName'=$upn;'DisplayName'=$DisplayName;'EmailAddress'=$Mail;'Company'=$Company;'CreationTime'=$CreationTime;'AccountAge(days)'=$AccountAge;'InvitationAccepted'=$InvitationAccepted;'CreationType'=$CreationType; 'GroupMembership'=$GroupMembership} 
- $Output= New-Object PSObject -Property $Result 
- $Output | Select-Object DisplayName,UserPrincipalName,Company,EmailAddress,CreationTime,AccountAge'(Days)',CreationType,InvitationAccepted,GroupMembership | Export-Csv -Path $ExportCSV -Notype -Append
+    #Check for recently created guest users
+    if(($RecentlyCreatedGuests -ne "") -and ([int]$AccountAge -gt $RecentlyCreatedGuests)) 
+    { 
+        return
+    }
+    $Company = $_.CompanyName
+    if($Company -eq $null)
+    {
+        $Company = "-"
+    }
+    $GroupMembership = @($_.MemberOf.AdditionalProperties.displayName) -join ','
+    if($GroupMembership -eq $null)
+    {
+        $GroupMembership = '-'
+    }
+    #Export result to CSV file 
+    $PrintedGuests++
+    $Result = [PSCustomObject] @{'DisplayName'=$DisplayName;'UserPrincipalName'=$_.UserPrincipalName;'Company'=$Company;'EmailAddress'=$_.Mail;'CreationTime'=$_.CreatedDateTime ;'AccountAge(days)'=$AccountAge;'CreationType'=$_.CreationType;'InvitationAccepted'=$_.ExternalUserState;'GroupMembership'=$GroupMembership} 
+    $Result | Export-Csv -Path $ExportCSV -Notype -Append
 }
 
- #Open output file after execution 
- Write-Host `nScript executed successfully
- if((Test-Path -Path $ExportCSV) -eq "True")
- {
-  Write-Host "Detailed report available in: $ExportCSV" -ForegroundColor Green
-  Write-Host `nThe Output file contains $PrintedGuests guest users.
-  $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 "$ExportCSV"  
-  } 
- }
- Else
- {
-  Write-Host No guest user found
- }
\ No newline at end of file
+#Open output file after execution 
+Write-Host `nScript executed successfully
+if((Test-Path -Path $ExportCSV) -eq "True")
+{
+    Write-Host "Detailed report available in: $ExportCSV" -ForegroundColor Green
+    Write-Host `nThe Output file contains $PrintedGuests guest users.
+    $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 "$ExportCSV"  
+    } 
+}
+else
+{
+    Write-Host "No guest user found" -ForegroundColor Red
+}
+Disconnect-MgGraph|Out-Null
\ No newline at end of file