Retrieve User Profile Properties From SharePoint Using CSOM PowerShell

Introduction

In this article, you will learn how to retrieve SharePoint user profile properties programmatically in different ways using CSOM with PowerShell on SharePoint 2013 / SharePoint online.

Steps Involved

The following prerequisites need to be executed before going for any operations using CSOM PowerShell on SharePoint sites.

  1. Add the references using the Add-Type command with necessary reference paths. The necessary references are Microsoft.SharePoint.Client.dll, Microsoft.SharePoint.Client.Runtime.dll and UserProfile dll.
    1. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"  
    2. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"  
    3. Add-Type -Path "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.UserProfiles.dll"  
  2. Initialize client context object with the site URL.
    1. $siteURL = ""  
    2. $ctx = New-Object Microsoft.SharePoint.Client.ClientContext($siteURL)  
  3. If you are trying to access SharePoint Online site, then you need to setup the site credentials with credentials parameter and get it set to the client context. 
    1. #Setting Credentials for o365 - Start  
    2. $userId = ""  
    3. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
    4. $creds = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($userId, $pwd)  
    5. $ctx.credentials = $creds  
    6. #Setting Credentials for o365 - End  
  4. If you are trying to access the SharePoint on premise site, then the credentials parameter is not required to be set to the context. But you need to run the code on the respective SharePoint server or you need to pass the network credentials and set the context.
    1. #Credentials for on premise site - Start  
    2. $pwd = Read-Host -Prompt "Enter password" -AsSecureString  
    3. $creds = New-Object System.Net.NetworkCredential("", $pwd)  
    4. $ctx.Credentials = $creds  
    5. #Credentials for on premise site - End  

Retrieve Current User Properties

  • Initialize the people manager object with the context to get the user profile data.

  • With people manager object, use GetMyProperties() method to retrieve current user profile information.

  • Load the object and execute query to get the data.

  • In the below code snippet, 

    • $myProperties variable holds few important user profile properties and whole collection as property
    • $myprofileProperties holds whole user profile properties collection which is retrieved from above variable.
    • These variables are key value pairs. Foreach loop can be used to retrieve the data.
      1. # Get My Profile Properties  
      2. function GetMyProperties(){  
      3.     try{  
      4.         $peopleManager = New-Object Microsoft.SharePoint.Client.UserProfiles.PeopleManager($ctx)  
      5.         $myProperties = $peopleManager.GetMyProperties()  
      6.         $ctx.Load($myProperties)  
      7.         $ctx.ExecuteQuery()     
      8.         # Gets all the user profile properties related to current user  
      9.         $myprofileProperties = $myProperties.UserProfileProperties  
      10.         foreach($key in $myprofileProperties.Keys){  
      11.             Write-Host $Key " : " $myprofileProperties[$key]  
      12.         }  
      13.     }  
      14.     catch{  
      15.         Write-Host "$($_.Exception.Message)" -foregroundcolor red   
      16.     }      
      17. }  

Retrieve Target User Profile Properties

In the above section, we have seen how we can retrieve the profile properties of the user who is running the script. Now we will see how we can retrieve target user profile properties. The steps followed are very similar to the above section. Only the method is changed to get the target user properties.

  • To get the target user profile information, we can use GetPropertiesFor() method along with people manager object and user id
    1. # Get Properties of target User  
    2. function GetUserProperties(){  
    3.     try{  
    4.         $peopleManager = New-Object Microsoft.SharePoint.Client.UserProfiles.PeopleManager($ctx)  
    5.         # Gets few user profile   
    6.         $userProperties = $peopleManager.GetPropertiesFor("i:0#.f|membership|abc@abc.onmicrosoft.com") #o365  
    7.         #$userProperties = $peopleManager.GetPropertiesFor("domain\userid") #on prem  
    8.         $ctx.Load($userProperties)  
    9.         $ctx.ExecuteQuery()     
    10.         # Gets all the user profile properties for target user  
    11.         $userprofileProperties = $userProperties.UserProfileProperties  
    12.         foreach($key in $userprofileProperties.Keys){  
    13.             Write-Host $Key " : " $userprofileProperties[$key]  
    14.         }  
    15.     }  
    16.     catch{  
    17.         Write-Host "$($_.Exception.Message)" -foregroundcolor red   
    18.     }  
    19. }  

Retrieve Few User Profile Properties

In the above section, we have seen how we can retrieve particular user profile information. Now, we will see how we can set/select the property names and retrieve the specific user information for any user.
  • Initialize the people manager object with the context to get the user profile data.

  • In the array, set the necessary property names to be retrieved.

  • Then initialize the UserProfilePropertiesForUser method, where we can set the context, target user id and the properties array defined.

  • With people manager object, use GetUserProfilePropertiesFor method with above object to retrieve current user profile information.

  • Load the object and execute query to get the data.
    1. # Get Few Properties of target User  
    2. function GetUserProfileProperties(){  
    3.     try{  
    4.         $peopleManager = New-Object Microsoft.SharePoint.Client.UserProfiles.PeopleManager($ctx)  
    5.         $properties = "PreferredName""Department""Title""HomePhone""Department"  
    6.         $userProfileProperties = New-Object Microsoft.SharePoint.Client.UserProfiles.UserProfilePropertiesForUser($ctx, "i:0#.f|membership|abc@abc.onmicrosoft.com", $properties) #o365  
    7.         #$userProfileProperties = New-Object Microsoft.SharePoint.Client.UserProfiles.UserProfilePropertiesForUser($ctx, "domain\userid", $properties) #on-prem  
    8.           
    9.         $userProfileValues = $peopleManager.GetUserProfilePropertiesFor($userProfileProperties)  
    10.         $ctx.Load($userProfileProperties)  
    11.         $ctx.ExecuteQuery()  
    12.         $counter = 0  
    13.         foreach($property in $properties){  
    14.             Write-Host $property " : " $userProfileValues[$counter]  
    15.             $counter++  
    16.         }          
    17.     }  
    18.     catch{  
    19.         Write-Host "$($_.Exception.Message)" -foregroundcolor Red  
    20.     }  
    21. }  

Note: The above set of operations needs to be called to get it executed.

  1. GetMyProperties # Get My Profile Properties  
  2. GetUserProperties # Get Properties of target User  
  3. GetUserProfileProperties # Get Few Properties of target User   
Summary

Thus you have learned how to retrieve user profile properties for any user by various approaches using CSOM with PowerShell on SharePoint 2013 / SharePoint online sites.