Retrieve User Profile Properties From SharePoint Using CSOM PowerShell

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|[email protected]") #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|[email protected]", $properties) #o365
  7. #$userProfileProperties = New-Object Microsoft.SharePoint.Client.UserProfiles.UserProfilePropertiesForUser($ctx, "domain\userid", $properties) #on-prem
  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.

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.