PowerShell Script to remove a Person from a People WebPart in a SharePoint online page

Question

Hi,

Can anyone tell me if is is possible to use a PowerShell Script to remove a Person from a People WebPart in a SharePoint online page?

I have the People WebPart and I have added people to this and its all working ok. I then want to remove a person when they leave the company but wondered if this can be scripted?

I was thinking that the script may be able to ask for the persons email address or user name and then look for that person in all of all of our sites webparts within the Tennent and remove them from these webparts?

Not sure if this is a possibility or not or even what the closest thing we could do to this ask?

TIA

Nigel

Answer 1

Hello there,

Parameters

$TenantURL = "https:// xxxx.sharepoint. com"
$UserID="i:0#.f|membership|user@X . com"

Get Credentials to connect

$Credential = Get-Credential

Frame Tenant Admin URL from Tenant URL

$TenantAdminURL = $TenantURL.Insert($TenantURL.IndexOf("."),"-admin")

Connect to PnP Online

Connect-PnPOnline -Url $TenantAdminURL -Credentials $Credential

Get All Site collections - Filter BOT and MySite Host

$Sites = Get-PnPTenantSite -Filter "Url -like '$TenantURL'"

Iterate through all sites

$Sites | ForEach-Object {
Write-host "Searching in Site Collection:"$.URL -f Yellow
#Connect to each site collection
Connect-PnPOnline -Url $.URL -Credentials $Credential
If((Get-PnPUser | Where {$.LoginName -eq $UserID}) -ne $NULL)
{
#Remove user from site collection
Remove-PnPUser -Identity $UserID -Confirm:$false
Write-host "`tRemoved the User from Site:"$.URL -f Green
}
}
This PnP PowerShell removes the user from all SharePoint Online sites in the tenant.

---

--If the reply is helpful, please Upvote and Accept it as an answer–

Answer 2

Hi @Nigel Foot ,

Please try to use this:

1.Input:

     $homePage = Get-PnPClientSidePage -Identity "page name"  
     $peoplePart = $homePage.Controls | ? {$_.Title -eq "People"}  

2.Input:

$peoplePart.PropertiesJson  

This is all the users in your People web part.

3.Remove the user you want.

For example, delete the following highlighted areas.
>

Input:

$peoplePart.PropertiesJson = '{"persons":[{"id":"i:0#.f|membership|xxx@tenant.onmicrosoft.com","role":"Technical Support","firstName":"","lastName":"","upn":"","phone":"","sip":"","department":""}],"layout":1}'  

4.Input:

     $homePage.Save()  

---

If the answer is helpful, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Answer 3

Hi @Nigel Foot

I see a discussion about programmatically adding people using WebPart with Get-PnPClientSidePage at https://techcommunity.microsoft.com/t5/sharepoint-developer/adding-people-to-the-people-web-part-programmatically-using/m-p/110559

Perhaps you could borrow the code to build a list and deploy it to the pages you specify (just an idea).

You can also try using Get-PnPWebPartProperty, process the output, and save it back to SharePoint using Set-PnPWebPartProperty:

Get-PnPWebPartProperty

https://pnp.github.io/powershell/cmdlets/Get-PnPWebPartProperty.html

Set-PnPWebPartProperty

https://pnp.github.io/powershell/cmdlets/Set-PnPWebPartProperty.html

-----------------------------

If this is helpful please accept answer.