mirror of
https://github.com/admindroid-community/powershell-scripts.git
synced 2025-12-17 16:35:19 +00:00
Export SPO External User report
Export SPO External User report
This commit is contained in:
AdminDroid
parent
ac5d20be4f
commit
95dbdce033
@ -0,0 +1,161 @@
|
||||
<#
|
||||
=============================================================================================
|
||||
Name: Export Office 365 SPO External Users Report
|
||||
Description: This script exports Office 365 SPO external users to CSV
|
||||
Version: 1.0
|
||||
website: o365reports.com
|
||||
Script by: O365Reports Team
|
||||
For detailed Script execution: http://o365reports.com/2021/08/03/get-all-external-users-in-sharepoint-online-powershell
|
||||
============================================================================================
|
||||
#>
|
||||
|
||||
param (
|
||||
[string] $UserName = $null,
|
||||
[string] $Password = $null,
|
||||
[Int] $GuestsCreatedWithin_Days,
|
||||
[Switch] $SiteWiseGuest,
|
||||
[Parameter(Mandatory = $True)]
|
||||
[string] $HostName = $null
|
||||
|
||||
)
|
||||
|
||||
#StartFromLine: 153
|
||||
|
||||
#Checks SharePointOnline module availability and connects the module
|
||||
Function ConnectSPOService {
|
||||
$SPOService = (Get-Module Microsoft.Online.SharePoint.PowerShell -ListAvailable).Name
|
||||
if ($SPOService -eq $Empty) {
|
||||
Write-host "Important: SharePoint Online Management Shell 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 module? [Y] Yes [N] No
|
||||
if ($confirm -match "[yY]") {
|
||||
Write-host "Installing SharePoint Online Management Shell Module"
|
||||
Install-Module -Name Microsoft.Online.SharePoint.PowerShell -Allowclobber -Repository PSGallery -Force
|
||||
Write-host "SharePoint Online Management Shell module is installed in the system successfully."
|
||||
}
|
||||
else {
|
||||
Write-host "Exiting. `nNote: SharePoint Online Management Shell module must be available in your system to run the script."
|
||||
Exit
|
||||
}
|
||||
}
|
||||
|
||||
#Storing credential in script for scheduling purpose/Passing credential as parameter
|
||||
$ConnectionUrl = "https://$HostName-admin.sharepoint.com/"
|
||||
if (($UserName -ne "") -and ($Password -ne "") -and ($HostName -ne "")) {
|
||||
$SecuredPassword = ConvertTo-SecureString -AsPlainText $Password -Force
|
||||
$Credential = New-Object System.Management.Automation.PSCredential $UserName, $SecuredPassword
|
||||
Connect-SPOService -Credential $Credential -Url $ConnectionUrl | Out-Null
|
||||
}
|
||||
else {
|
||||
Connect-SPOService -Url $ConnectionUrl | Out-Null
|
||||
}
|
||||
Write-Host "SharePoint Online Management Shell module is connected successfully"
|
||||
#End of Connecting SPO Module
|
||||
}
|
||||
|
||||
#This function checks the user choice and get the guest user data
|
||||
Function FindGuestUsers {
|
||||
$AllGuestUserData = @()
|
||||
$global:ExportCSVFileName = "SPOExternalUsersReport-" + ((Get-Date -format "MMM-dd hh-mm-ss tt").ToString()) + ".csv"
|
||||
|
||||
#Checks the SPO Sites and lists the guest users
|
||||
if ($SiteWiseGuest.IsPresent) {
|
||||
$GuestDataAvailable = $false
|
||||
Get-SPOSite | foreach-object {
|
||||
$CurrSite = $_
|
||||
Write-Progress "Finding the guest users in the site: $($CurrSite.Url)" "Processing the sites with guest users..."
|
||||
#Fiters the sites with guest users
|
||||
Get-SPOUser -Site $CurrSite.Url | where-object { $_.LoginName -like "*#ext#*" -or $_.LoginName -like "urn:spo:guest#*"} | foreach-object {
|
||||
$global:ExportedGuestUser = $global:ExportedGuestUser + 1
|
||||
$CurrGuestData = $_
|
||||
ExportGuestsAndSitesData
|
||||
}
|
||||
}
|
||||
if ($global:ExportedGuestUser -eq 0) {
|
||||
Write-Host "No SharePoint Online guests in any SharePoint Online sites in your tenant" -ForegroundColor Magenta
|
||||
}
|
||||
}
|
||||
|
||||
#Checks the guest user acount creation within the mentioned days and retrieves it
|
||||
elseif ($GuestsCreatedWithin_Days -gt 0) {
|
||||
$AccountCreationDate = (Get-date).AddDays(-$GuestsCreatedWithin_Days).Date
|
||||
for (($i = 0), ($errVar = @()); (($errVar.Count) -eq 0); $i += 50) {
|
||||
Get-SPOExternalUser -Position $i -PageSize 50 -ErrorAction SilentlyContinue -ErrorVariable errVar | where-object { $_.WhenCreated -ge $AccountCreationDate } | foreach-object {
|
||||
$global:ExportedGuestUser = $global:ExportedGuestUser + 1
|
||||
$CurrGuestData = $_
|
||||
ExportGuestUserDetails
|
||||
}
|
||||
}
|
||||
if ($global:ExportedGuestUser -eq 0) {
|
||||
Write-host "No SharePoint Online guests created in last $GuestsCreatedWithin_Days days" -ForegroundColor Magenta
|
||||
}
|
||||
}
|
||||
|
||||
#Returns all SPO guest users in your tenant
|
||||
else {
|
||||
for (($i = 0), ($errVar = @()); (($errVar.Count) -eq 0); $i += 50) {
|
||||
Get-SPOExternalUser -Position $i -PageSize 50 -ErrorAction SilentlyContinue -ErrorVariable errVar | ForEach-Object {
|
||||
$global:ExportedGuestUser = $global:ExportedGuestUser + 1
|
||||
$CurrGuestData = $_
|
||||
ExportGuestUserDetails
|
||||
}
|
||||
}
|
||||
if ($global:ExportedGuestUser -eq 0) {
|
||||
Write-Host "No SharePoint Online guest users found in your tenant." -ForegroundColor Magenta
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#Saves site-wise guest user data
|
||||
Function ExportGuestsAndSitesData {
|
||||
$SiteName = $CurrSite.Title
|
||||
$SiteUrl = $CurrSite.Url
|
||||
$GuestDisplayName = $CurrGuestData.DisplayName
|
||||
$GuestEmailAddress = $CurrGuestData.LoginName
|
||||
if($GuestEmailAddress -like "*ext*"){
|
||||
$GuestDomain = ($CurrGuestData.LoginName).split("_#") | Select-Object -Index 1
|
||||
}
|
||||
else{
|
||||
$GuestDomain = ($CurrGuestData.LoginName).split("@") | Select-Object -Index 1
|
||||
}
|
||||
|
||||
$ExportResult = @{'Guest User' = $GuestDisplayName; 'Email Address' = $GuestEmailAddress; 'Site Name' = $SiteName; 'Site Url' = $SiteUrl; 'Guest Domain' = $GuestDomain }
|
||||
$ExportResults = New-Object PSObject -Property $ExportResult
|
||||
$ExportResults | Select-object 'Guest User', 'Email Address', 'Site Name', 'Site Url', 'Guest Domain' | Export-csv -path $global:ExportCSVFileName -NoType -Append -Force
|
||||
|
||||
}
|
||||
|
||||
#Saves guest user data
|
||||
Function ExportGuestUserDetails {
|
||||
$GuestDisplayName = $CurrGuestData.DisplayName
|
||||
$GuestEmailAddress = $CurrGuestData.Email
|
||||
$GuestInviteAcceptedAs = $CurrGuestData.AcceptedAs
|
||||
$CreationDate = ($CurrGuestData.WhenCreated).ToString().split(" ") | Select-Object -Index 0
|
||||
$GuestDomain = ($CurrGuestData.Email).split("@") | Select-Object -Index 1
|
||||
|
||||
Write-Progress "Retrieving the Guest User: $GuestDisplayName" "Processed Guest Users Count: $global:ExportedGuestUser"
|
||||
|
||||
#Exports the guest user data to the csv file format
|
||||
|
||||
$ExportResult = @{'Guest User' = $GuestDisplayName; 'Email Address' = $GuestEmailAddress; 'Invitation Accepted via' = $GuestInviteAcceptedAs; 'Created On' = $CreationDate; 'Guest Domain' = $GuestDomain }
|
||||
$ExportResults = New-Object PSObject -Property $ExportResult
|
||||
$ExportResults | Select-object 'Guest User', 'Email Address', 'Created On', 'Invitation Accepted via', 'Guest Domain' | Export-csv -path $global:ExportCSVFileName -NoType -Append -Force
|
||||
|
||||
}
|
||||
|
||||
#Execution starts here.
|
||||
ConnectSPOService
|
||||
$global:ExportedGuestUser = 0
|
||||
FindGuestUsers
|
||||
|
||||
if ((Test-Path -Path $global:ExportCSVFileName) -eq "True") {
|
||||
#Open file after code execution finishes
|
||||
Write-Host "The output file available in $global:ExportCSVFileName" -ForegroundColor Green
|
||||
write-host "Exported $global:ExportedGuestUser records to CSV."
|
||||
$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 "$global:ExportCSVFileName"
|
||||
}
|
||||
}
|
||||
Disconnect-SPOService
|
||||
Write-host "Disconnected SPOService Session Successfully"
|
||||
Loading…
x
Reference in New Issue
Block a user