SharePoint Diary » User Profile » SharePoint Online: Get User Profile Properties using PowerShell

SharePoint Online: Get User Profile Properties using PowerShell

March 6, 2023 Salaudeen Rajack 4 Comments get all user profile properties sharepoint online, get user profile properties in sharepoint online, get user profile properties sharepoint online powershell, how to get user profile properties in sharepoint online using powershell, sharepoint online get user profile properties csom, sharepoint online get user profile properties powershell

Requirement: SharePoint Online Get All User Profiles and export to CSV.

How to Get User Profile Properties in SharePoint Online?

In this blog post, we will take a look at how to get user profile properties in SharePoint Online. We will be looking at how to use PowerShell for SharePoint Online, retrieve the properties of a user profile, and then use the SharePoint Admin center to get the profile properties of a specific user. We will also look at some example scripts that retrieve either a particular property or all properties of a given user profile.

A user profile property is a field that holds user data such as “First Name”, “Last Name”, “Department”, “Skills”, etc. By default, SharePoint already has a rich set of user profile properties. To get all user profiles and user profile properties in SharePoint Online, follow these steps:

Login to SharePoint Online Admin Center >> Click on the “More Features” link from the left navigation >> Click on the “Open” button under “User Profiles”.
In User Profiles, click on the “Manage User Profiles” link under the People tab.
Use Search to get the user profile of the user >> Choose “Edit My Profile” from the context menu.

This interface helps us to get individual user profiles and properties one by one. Now, let’s see how to get user profile properties in SharePoint Online using PowerShell.

To get all available properties from user profile service, use: $UserProfile.UserProfileProperties.Keys

SharePoint Online PowerShell to Get User Profile Properties

Here is the PowerShell to get all user profiles in SharePoint Online. It gets the specific property “Department” of the particular user from the given site collection.

#Load SharePoint CSOM Assemblies
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"
Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.UserProfiles.dll"

Function Get-SPOUserProfileProperty()
{
    param
    (
        [Parameter(Mandatory=$true)] [string] $AdminSiteURL,
        [Parameter(Mandatory=$true)] [string] $UserAccount,
        [Parameter(Mandatory=$true)] [string] $Property
    )    
    Try {
        #Setup Credentials to connect
        $Cred= Get-Credential
        $Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.Username, $Cred.Password)

        #Setup the context
        $Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($AdminSiteURL)
        $Ctx.Credentials = $Credentials
        
        #Get the User
        $User = $Ctx.web.EnsureUser($UserAccount)
        $Ctx.Load($User)
        $Ctx.ExecuteQuery()

        #Get User Profile
        $PeopleManager = New-Object Microsoft.SharePoint.Client.UserProfiles.PeopleManager($Ctx)
        $UserProfile = $PeopleManager.GetPropertiesFor($User.LoginName)
        $Ctx.Load($UserProfile)
        $Ctx.ExecuteQuery()
        
        #Get the User Profile Property
        Write-host $UserProfile.UserProfileProperties[$Property]

    }
    Catch {
        write-host -f Red "Error Getting User Profile Properties!" $_.Exception.Message
    }
}
#Call the function
$AdminSiteURL="https://crescent-admin.sharepoint.com"
$UserAccount="[email protected]"
$Property="Department"

Get-SPOUserProfileProperty -AdminSiteURL $AdminSiteURL -UserAccount $UserAccount -Property $Property

This PowerShell gets the particular property of a specific user. Similarly, you can get any available user property such as Email, Manager, etc., from the SharePoint Online user profile using PowerShell.