Skip to content

Instantly share code, notes, and snippets.

@reshmee011
Last active August 7, 2024 08:32
Show Gist options
  • Save reshmee011/be60dcf4e73c250aa408441423835c62 to your computer and use it in GitHub Desktop.
Save reshmee011/be60dcf4e73c250aa408441423835c62 to your computer and use it in GitHub Desktop.
GetSharingLinks_REST
#Parameters
$tenantUrl = Read-Host -Prompt "Enter tenant collection URL";
$dateTime = (Get-Date).toString("dd-MM-yyyy-hh-ss")
$invocation = (Get-Variable MyInvocation).Value
$directorypath = Split-Path $invocation.MyCommand.Path
$fileName = "SharedLinks_REST-" + $dateTime + ".csv"
$ReportOutput = $directorypath + "\Logs\"+ $fileName
# Ensure the logs folder exists
$logsFolder = Split-Path -Path $ReportOutput -Parent
if (-not (Test-Path -Path $logsFolder)) {
New-Item -Path $logsFolder -ItemType Directory
}
# Ensure the file exists
if (-not (Test-Path -Path $ReportOutput)) {
New-Item -Path $ReportOutput -ItemType File
}
#Connect to PnP Online
Connect-PnPOnline -Url $tenantUrl -Interactive
write-host $("Start time " + (Get-Date))
$global:Results = @();
function Get-ListItems_WithUniquePermissions{
param(
[Parameter(Mandatory)]
[Microsoft.SharePoint.Client.List]$List
)
$selectFields = "ID,HasUniqueRoleAssignments,FileRef,FileLeafRef,FileSystemObjectType"
$Url = $siteUrl + '/_api/web/lists/getbytitle(''' + $($list.Title) + ''')/items?$select=' + $($selectFields)
$nextLink = $Url
$listItems = @()
$Stoploop =$true
while($nextLink){
do{
try {
$response = invoke-pnpsprestmethod -Url $nextLink -Method Get
$Stoploop =$true
}
catch {
write-host "An error occured: $_ : Retrying" -ForegroundColor Red
$Stoploop =$true
Start-Sleep -Seconds 30
}
}
While ($Stoploop -eq $false)
$listItems += $response.value | where-object{$_.HasUniqueRoleAssignments -eq $true}
if($response.'odata.nextlink'){
$nextLink = $response.'odata.nextlink'
} else{
$nextLink = $null
}
}
return $listItems
}
function getSharingLink($_object,$_type,$_siteUrl,$_list)
{
$relativeUrl = $_object.FileRef
$sharingSettings = Invoke-PnPSPRestMethod -Method Post -Url "$($_siteUrl)/_api/web/Lists(@a1)/GetItemById(@a2)/GetSharingInformation?@a1='{$($_list.Id)}'&@a2='$($_object.Id)'&`$Expand=permissionsInformation,pickerSettings" -ContentType "application/json;odata=verbose" -Content "{}"
ForEach ($shareLink in $sharingSettings.permissionsInformation.links)
{
Write-Host "Shared links found in '$relativeUrl'"
$linkDetails = $shareLink.linkDetails
if ($linkDetails.Url) {
$invitees = (
$linkDetails.Invitations |
ForEach-Object { $_.Invitee.email }
) -join '|'
$LastModified = Get-Date -Date $linkDetails.LastModified
$linkAccess = "ViewOnly"
if ($linkDetails.IsEditLink) {
$linkAccess = "Edit"
}
elseif ($linkDetails.IsReviewLink) {
$linkAccess = "Review"
}
$sharedLinkObject = New-Object PSObject -property $([ordered]@{
ItemID = $item.Id
ShareLink = $linkDetails.Url
Invitees = $invitees
Name = $_object.FileLeafRef ?? $_object.Title
Type = $_type -eq 1 ? "Folder" : "File"
RelativeURL = $_object.FileRef ?? ""
LinkAccess = $linkAccess
Created = Get-Date -Date $linkDetails.Created
CreatedBy = $linkDetails.CreatedBy.email
LastModifiedBy = $linkDetails.LastModifiedBy.email
LastModified = $LastModified
ShareLinkType = $linkDetails.LinkKind
Expiration = $linkDetails.Expiration
BlocksDownload = $linkDetails.BlocksDownload
RequiresPassword = $linkDetails.RequiresPassword
PasswordLastModified = $linkDetails.PasswordLastModified
PassLastModifiedBy = $linkDetails.PasswordLastModifiedBy.email
HasExternalGuestInvitees = $linkDetails.HasExternalGuestInvitees
HasAnonymousLink = $linkDetails.HasAnonymousLink
AllowsAnonymousAccess = $linkDetails.AllowsAnonymousAccess
ShareTokenString = $linkDetails.ShareTokenString
# Add other properties as needed
})
$global:Results +=$sharedLinkObject;
}
}
}
#Exclude system lists
$ExcludedLists = @("Access Requests", "App Packages", "appdata", "appfiles", "Apps in Testing", "Cache Profiles", "Composed Looks", "Content and Structure Reports", "Content type publishing error log", "Converted Forms",
"Device Channels", "Form Templates", "fpdatasources", "Get started with Apps for Office and SharePoint", "List Template Gallery", "Long Running Operation Status", "Maintenance Log Library", "Images", "site collection images"
, "Master Docs", "Master Page Gallery", "MicroFeed", "NintexFormXml", "Quick Deploy Items", "Relationships List", "Reusable Content", "Reporting Metadata", "Reporting Templates", "Search Config List", "Site Assets", "Preservation Hold Library",
"Site Pages", "Solution Gallery", "Style Library", "Suggested Content Browser Locations", "Theme Gallery", "TaxonomyHiddenList", "User Information List", "Web Part Gallery", "wfpub", "wfsvc", "Workflow History", "Workflow Tasks", "Pages")
$m365Sites = Get-PnPTenantSite| Where-Object { $_.Url -like '*/sites/*' -and $_.Template -ne 'RedirectSite#0' }
$m365Sites | ForEach-Object {
$siteUrl = $_.Url;
Connect-PnPOnline -Url $siteUrl -Interactive
Write-Host "Processing site $siteUrl" -Foregroundcolor "Red";
#getSharingLink $ctx $web "site" $siteUrl "";
$ll = Get-PnPList -Includes BaseType, Hidden, Title,HasUniqueRoleAssignments,RootFolder | Where-Object {$_.Hidden -eq $False -and $_.Title -notin $ExcludedLists } #$_.BaseType -eq "DocumentLibrary"
Write-Host "Number of lists $($ll.Count)";
foreach($list in $ll)
{
#Get all list items in batches
$ListItems = Get-ListItems_WithUniquePermissions -List $list
ForEach($item in $ListItems)
{
$type= $item.FileSystemObjectType;
getSharingLink $item $type $siteUrl $list;
}
}
}
$global:Results | Export-CSV $ReportOutput -NoTypeInformation
Write-host -f Green "Sharing Links Report Generated Successfully!"
write-host $("End time " + (Get-Date))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment