cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
AeronC
Frequent Visitor

Sharepoint User Profile Details in PowerApps - SharePoint REST API

Hello Everyone!

 

I'm trying to retrieve Sharepoint Online (SPO) User Profile properties using the Sharepoint REST API via a custom connector in PowerApps.

 

For an easy example: the DisplayName property of the current User.

 

(Note: I am actually trying to retrieve custom defined user profile properties "PrimaryArea", "SecondaryArea" etc... from SPO, due to the fact that 'Term Sets' can be defined for these properties; something that I believe to not be possible for the Azure AD user resource (even through custom schema extensions) or the Office365 user profile.)

Therefore I do not think the Office365Users or AzureAD connectors are a suitable alternative. Please let me know If I am wrong about this as it would solve my problem quickly.

 

I have a custom connector that gives the following HTTP response to a GET request;

 

{
  "odata.metadata": "https://example.sharepoint.com/_api/$metadata#Edm.String",
  "value": "Aeron Campbell"
}

with the headers;

 

{
  "cache-control": "private, max-age=0",
  "content-encoding": "gzip",
  "content-type": "application/json;odata=minimalmetadata;streaming=true;charset=utf-8",
  "dataserviceversion": "3.0",
  "date": "Wed, 17 Jul 2019 23:08:06 GMT",
  "expires": "Tue, 02 Jul 2019 23:08:06 GMT",
  "last-modified": "Wed, 17 Jul 2019 23:08:06 GMT",
  "microsoftsharepointteamservices": "16.0.0.9103",
  "ms-cv": "nvFF46pwAJADMbkfRgFydA.0",
  "p3p": "CP=\"ALL IND DSP COR ADM CONo CUR CUSo IVAo IVDo PSA PSD TAI TELo OUR SAMo CNT COM INT NAV ONL PHY PRE PUR UNI\"",
  "request-id": "e345f19e-70aa-9000-0331-b91f46017274",
  "spclientservicerequestduration": "281",
  "sprequestguid": "e345f19e-70aa-9000-0331-b91f46017274",
  "strict-transport-security": "max-age=31536000",
  "vary": "Accept-Encoding",
  "x-aspnet-version": "4.0.30319",
  "x-content-type-options": "nosniff",
  "x-frame-options": "SAMEORIGIN",
  "x-ms-invokeapp": "1; RequireReadOnly",
  "x-powered-by": "ASP.NET",
  "x-sharepointhealthscore": "0",
  "x-sp-serverstate": "ReadOnly=0"
}

Notice how expires is before the date. Could this be the issue?

The custom connector is defined as an OpenAPI file below:

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "SharePointUsers",
    "description": "Access Sharepoint User details using this API", 
    "contact": {
    "name": "Aeron Campbell",
    "email": "Aeron.Campbell@example.co.uk"
    }
  },
  "host": "example.sharepoint.com",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json;odata=verbose"
  ],
  "produces": [
    "application/json;odata=verbose"
  ],
  "securityDefinitions": {
    "AAD": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
      "scopes": {}
    }
  },
  "paths": {
    "/_api/SP.UserProfiles.PeopleManager/GetMyProperties/DisplayName": {
      "get": {
        "description": "Get current Sharepoint user properties",
        "summary": "Get My Properties",
        "operationId": "GetSharepointUser",
        "x-ms-visibility": "important",
        "consumes": ["application/json;odata=verbose"],
        "produces": ["application/json;odata=verbose"],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "500": {
            "description": "Internal Server Error"
          },
          "default": {
            "description": "Operation Failed."
          }
        }
      }
    }
  }
}

However when using the custom connector within Powerapps I keep getting the following error. (See attachment)

 

SharePointUsers.GetSharepointUser() failed: The data returned in the response is invalid.

 

Could this be because of how I have defined the JSON schema in the OpenAPI file? or becasue the response is stale? or just because of how Powerapps expects to recieve data?

 

I am fairly new to PowerApps, OpenAPI, REST API, HTTP Requests and the whole Microsoft Eco System/Platform as a whole so I would greatly apprectiate any advice regarding what I am trying to achieve!

 

I have used the following resource to create the custom connector and app registrations in Azure and whatnot...

https://powerapps.microsoft.com/en-us/blog/implementing-role-based-permission/

 

I have also looked at achieving this through a Flow using the information in this thread:

https://powerusers.microsoft.com/t5/General-Discussion/Role-based-security-groups-in-Powerapps-using...
Is this the correct way to produce HTTP requests from Powerapps?

As a sidenote, during the App Registration Step in the Azure Portal I have given the following API Permissions under Sharepoint:

User.Read.All

User.ReadWrite.All

I don't believe this step to be neccessary as I dont think these permissions relate to the Sharepoint REST API. Does any have more info regarding what these permissions are and what they relate to? As google has been no help.

 

Please let me know if what I am trying to achieve is possible in Powerapps and is the best/optimal way to retrieve SPO User Properties, as even the built in Sharepoint Connector cannot access user profiles.

Also are there plans to depreciate the use of the Sharepoint REST API and User Profiles in the near future? as a lot of the documentation is no longer being updated.

 

 

4 REPLIES 4
AeronC
Frequent Visitor

As an update to this,

the reply actually recieved when in the Powerapp is XML.

I know the Sharepoint REST API defaults to XML, but why am I seeing a different result compared to when testing the connector in the powerapps edit connector screen?

 

<?xml version="1.0" encoding="utf-8"?>
<d:DisplayName xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
Aeron Campbell
</d:DisplayName>

Why does powerapps not supply the correct ACCEPT HTTP header with the request?

 

 

DeeTronSEAM
Kudo Collector
Kudo Collector

@AeronC I hope this reply doesn't get your hopes up, but I wanted to tell you two things:

 

1) Your post has to be one of the most clear and well-laid out (and pre-researched before asking) posts I've seen in these forums.  I wish people did such a good job explaining their problem (and what they've tried already).

 

2) I am getting a "The data returned in the response is invalid" error in PowerApps from a Flow I built (which calls the MS Graph API).  I get the expected returned JSON back into PApps but PApps still compains and I cannot figure out why?

 

So, even though I am not using a custom connector (I'm using the Action menu in PApps to bind to my Flow), I'm doubly disappointed that there has been no answers to your post.  I.e. not only do you deserve one, but it might shed some light on my problem.  Best wishes!

Anonymous
Not applicable

Hi, 

Did you ever resolve this issue?

ceylon
Regular Visitor

Hello all!

 

First, I just wanted to also say thank you @AeronC. I am in agreement with @DeeTronSEAM about how your post was very clear and researched. You did such an amazing job on your post, it ultimately helped me to solve the problem!

 

Where your post helps the most is that I also needed custom defined UserProfileProperties as stated: 

 


@AeronC wrote:

 

(Note: I am actually trying to retrieve custom defined user profile properties "PrimaryArea", "SecondaryArea" etc... from SPO, due to the fact that 'Term Sets' can be defined for these properties; something that I believe to not be possible for the Azure AD user resource (even through custom schema extensions) or the Office365 user profile.)

 


To achieve this I needed to modify the SharePoint REST API call to: 

 

 

https://<site url>/_api/SP.UserProfiles.PeopleManager/GetMyProperties/UserProfileProperties

 

 

This returns a list of only the UserProfileProperties of the currently logged-in user in XML format

 

To retrieve this as JSON (which is required by PowerApps) an Accept header parameter needed to be sent along with the request. You can see this in the code section called "parameters". But you also need to set this header in PowerApps when you request the data. This is addressed later in my reply.

 

To be fair I started with your excellent Swagger file and made a few modifications to the "paths", "responses" -> "200", and "parameters" sections.

 

"paths"

 

"paths": {
    "/_api/SP.UserProfiles.PeopleManager/GetMyProperties/UserProfileProperties":

 

"responses" -> "200"

 

"200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "d": {
                  "type": "object",
                  "properties": {
                    "UserProfileProperties": {
                      "type": "object",
                      "properties": {
                        "__metadata": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "description": "type"
                            }
                          },
                          "description": "__metadata"
                        },
                        "results": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "Key": {
                                "type": "string",
                                "description": "Key"
                              },
                              "Value": {
                                "type": "string",
                                "description": "Value"
                              },
                              "ValueType": {
                                "type": "string",
                                "description": "ValueType"
                              }
                            }
                          },
                          "description": "results"
                        }
                      },
                      "description": "UserProfileProperties"
                    }
                  },
                  "description": "d"
                }
              }
            }
          },

 

"parameters"

 

"parameters": [
          {
            "name": "Accept",
            "in": "header",
            "required": true,
            "type": "string",
            "x-ms-visibility": "important",
            "default": "application/json;odata=verbose"
          }
        ]

 

 

Once these changes had been made I was able to successfully retrieve the data from SharePoint in a JSON format that was readable by PowerApps.

 

In my PowerApp I connected this custom connector and was able to access the data by using the following formula:

 

 

SharePointUsers.GetSharepointUser("application/json;odata=verbose").d.UserProfileProperties.results

 

 

Where:

SharePointUsers = the custom connection to SharePoint

GetSharepointUser("application/json;odata=verbose") = the connection Action plus the required Accept header parameter

d = the returned data element

UserProfileProperties = the profile properties collection including metadata

results = array of profile property items

 

As you can see from the snip bellow, I was able to load this data into a gallery. You can also see that my custom defined properties, "StatusCode", "ApproverGroup", and "MinuteWriter" are part of the results.

 

spuserprofiles.PNG

 

I have posted my full Swagger file below so that others may benefit. Thanks again @AeronC for your post.

 

 

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "SharePointUsers",
    "description": "Access Sharepoint User details using this API",
    "contact": {
      "name": "Ceylon",
      "email": "ceylon@example.com"
    }
  },
  "host": "example.sharepoint.com",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json;odata=verbose"
  ],
  "produces": [
    "application/json;odata=verbose"
  ],
  "paths": {
    "/_api/SP.UserProfiles.PeopleManager/GetMyProperties/UserProfileProperties": {
      "get": {
        "description": "Get current Sharepoint user properties",
        "summary": "Get My Properties",
        "operationId": "GetSharepointUser",
        "x-ms-visibility": "important",
        "consumes": [
          "application/json;odata=verbose"
        ],
        "produces": [
          "application/json;odata=verbose"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "object",
              "properties": {
                "d": {
                  "type": "object",
                  "properties": {
                    "UserProfileProperties": {
                      "type": "object",
                      "properties": {
                        "__metadata": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "description": "type"
                            }
                          },
                          "description": "__metadata"
                        },
                        "results": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "Key": {
                                "type": "string",
                                "description": "Key"
                              },
                              "Value": {
                                "type": "string",
                                "description": "Value"
                              },
                              "ValueType": {
                                "type": "string",
                                "description": "ValueType"
                              }
                            }
                          },
                          "description": "results"
                        }
                      },
                      "description": "UserProfileProperties"
                    }
                  },
                  "description": "d"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "500": {
            "description": "Internal Server Error"
          },
          "default": {
            "description": "Operation Failed."
          }
        },
        "parameters": [
          {
            "name": "Accept",
            "in": "header",
            "required": true,
            "type": "string",
            "x-ms-visibility": "important",
            "default": "application/json;odata=verbose"
          }
        ]
      }
    }
  },
  "definitions": {},
  "parameters": {},
  "responses": {},
  "securityDefinitions": {
    "oauth2_auth": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
      "tokenUrl": "https://login.windows.net/common/oauth2/authorize",
      "scopes": {}
    }
  },
  "security": [
    {
      "oauth2_auth": []
    }
  ],
  "tags": []
}

 

 

Helpful resources

Announcements

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Copilot Studio Product Team

  It's time for the SECOND Power Apps Copilot Coffee Chat featuring the Copilot Studio product team, which will be held LIVE on April 3, 2024 at 9:30 AM Pacific Daylight Time (PDT).     This is an incredible opportunity to connect with members of the Copilot Studio product team and ask them anything about Copilot Studio. We'll share our special guests with you shortly--but we want to encourage to mark your calendars now because you will not want to miss the conversation.   This live event will give you the unique opportunity to learn more about Copilot Studio plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!   TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on April 2nd.Users posting Kudos after April 2nd. at 9AM PDT may not receive an invitation but will be able to view the session online after conclusion of the event. Give your "kudo" today and mark your calendars for April 3rd, 2024 at 9:30 AM PDT and join us for an engaging and informative session!

Tuesday Tip: Unlocking Community Achievements and Earning Badges

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!     THIS WEEK'S TIP: Unlocking Achievements and Earning BadgesAcross the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. These badges each signify a different achievement--and all of those achievements are available to any Community member! If you're a seasoned pro or just getting started, you too can earn badges for the great work you do. Check out some details on Community badges below--and find out more in the detailed link at the end of the article!       A Diverse Range of Badges to Collect The badges you can earn in the Community cover a wide array of activities, including: Kudos Received: Acknowledges the number of times a user’s post has been appreciated with a “Kudo.”Kudos Given: Highlights the user’s generosity in recognizing others’ contributions.Topics Created: Tracks the number of discussions initiated by a user.Solutions Provided: Celebrates the instances where a user’s response is marked as the correct solution.Reply: Counts the number of times a user has engaged with community discussions.Blog Contributor: Honors those who contribute valuable content and are invited to write for the community blog.       A Community Evolving Together Badges are not only a great way to recognize outstanding contributions of our amazing Community members--they are also a way to continue fostering a collaborative and supportive environment. As you continue to share your knowledge and assist each other these badges serve as a visual representation of your valuable contributions.   Find out more about badges in these Community Support pages in each Community: All About Community Badges - Power Apps CommunityAll About Community Badges - Power Automate CommunityAll About Community Badges - Copilot Studio CommunityAll About Community Badges - Power Pages Community

Tuesday Tips: Powering Up Your Community Profile

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   This Week's Tip: Power Up Your Profile!  🚀 It's where every Community member gets their start, and it's essential that you keep it updated! Your Community User Profile is how you're able to get messages, post solutions, ask questions--and as you rank up, it's where your badges will appear and how you'll be known when you start blogging in the Community Blog. Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile.     Password Puzzles? No Problem! Find out how to sync your Azure AD password with your community account, ensuring a seamless sign-in. No separate passwords to remember! Job Jumps & Email Swaps Changed jobs? Got a new email? Fear not! You'll find out how to link your shiny new email to your existing community account, keeping your contributions and connections intact. Username Uncertainties Unraveled Picking the perfect username is crucial--and sometimes the original choice you signed up with doesn't fit as well as you may have thought. There's a quick way to request an update here--but remember, your username is your community identity, so choose wisely. "Need Admin Approval" Warning Window? If you see this error message while using the community, don't worry. A simple process will help you get where you need to go. If you still need assistance, find out how to contact your Community Support team. Whatever you're looking for, when it comes to your profile, the Community Account Support Knowledge Base article is your treasure trove of tips as you navigate the nuances of your Community Profile. It’s the ultimate resource for keeping your digital identity in tip-top shape while engaging with the Power Platform Community. So, dive in and power up your profile today!  💪🚀   Community Account Support | Power Apps Community Account Support | Power AutomateCommunity Account Support | Copilot Studio  Community Account Support | Power Pages

Super User of the Month | Chris Piasecki

In our 2nd installment of this new ongoing feature in the Community, we're thrilled to announce that Chris Piasecki is our Super User of the Month for March 2024. If you've been in the Community for a while, we're sure you've seen a comment or marked one of Chris' helpful tips as a solution--he's been a Super User for SEVEN consecutive seasons!       Since authoring his first reply in April 2020 to his most recent achievement organizing the Canadian Power Platform Summit this month, Chris has helped countless Community members with his insights and expertise. In addition to being a Super User, Chris is also a User Group leader, Microsoft MVP, and a featured speaker at the Microsoft Power Platform Conference. His contributions to the new SUIT program, along with his joyous personality and willingness to jump in and help so many members has made Chris a fixture in the Power Platform Community.   When Chris isn't authoring solutions or organizing events, he's actively leading Piasecki Consulting, specializing in solution architecture, integration, DevOps, and more--helping clients discover how to strategize and implement Microsoft's technology platforms. We are grateful for Chris' insightful help in the Community and look forward to even more amazing milestones as he continues to assist so many with his great tips, solutions--always with a smile and a great sense of humor.You can find Chris in the Community and on LinkedIn. Thanks for being such a SUPER user, Chris! 💪🌠

Tuesday Tips: Community Ranks and YOU

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!This Week: Community Ranks--Moving from "Member" to "Community Champion"   Have you ever wondered how your fellow community members ascend the ranks within our community? What sets apart an Advocate from a Helper, or a Solution Sage from a Community Champion? In today’s #TuesdayTip, we’re unveiling the secrets and sharing tips to help YOU elevate your ranking—and why it matters to our vibrant communities. Community ranks serve as a window into a member’s role and activity. They celebrate your accomplishments and reveal whether someone has been actively contributing and assisting others. For instance, a Super User is someone who has been exceptionally helpful and engaged. Some ranks even come with special permissions, especially those related to community management. As you actively participate—whether by creating new topics, providing solutions, or earning kudos—your rank can climb. Each time you achieve a new rank, you’ll receive an email notification. Look out for the icon and rank name displayed next to your username—it’s a badge of honor! Fun fact: Your Community Engagement Team keeps an eye on these ranks, recognizing the most passionate and active community members. So shine brightly with valuable content, and you might just earn well-deserved recognition! Where can you see someone’s rank? When viewing a post, you’ll find a member’s rank to the left of their name.Click on a username to explore their profile, where their rank is prominently displayed. What about the ranks themselves? New members start as New Members, progressing to Regular Visitors, and then Frequent Visitors.Beyond that, we have a categorized system: Kudo Ranks: Earned through kudos (teal icons).Post Ranks: Based on your posts (purple icons).Solution Ranks: Reflecting your solutions (green icons).Combo Ranks: These orange icons combine kudos, solutions, and posts. The top ranks have unique names, making your journey even more exciting! So dive in, collect those kudos, share solutions, and let’s see how high you can rank! 🌟 🚀   Check out the Using the Community boards in each of the communities for more helpful information!  Power Apps, Power Automate, Copilot Studio & Power Pages

Find Out What Makes Super Users So Super

We know many of you visit the Power Platform Communities to ask questions and receive answers. But do you know that many of our best answers and solutions come from Community members who are super active, helping anyone who needs a little help getting unstuck with Business Applications products? We call these dedicated Community members Super Users because they are the real heroes in the Community, willing to jump in whenever they can to help! Maybe you've encountered them yourself and they've solved some of your biggest questions. Have you ever wondered, "Why?"We interviewed several of our Super Users to understand what drives them to help in the Community--and discover the difference it has made in their lives as well! Take a look in our gallery today: What Motivates a Super User? - Power Platform Community (microsoft.com)

Top Solution Authors
Top Kudoed Authors
Users online (5,912)