Edit

Share via

Manage profile source precedence settings for an organization using the Microsoft Graph API (preview)

Profile source precedence is a feature that empowers tenant admins with control over the source of profile data for their organization's users. Profile data might originate from Microsoft Entra ID, organizational data in Microsoft 365, user profile synchronization, or other sources. When multiple sources provide overlapping data, a tenant administrator can configure the authoritative source of profile data for users in their organization.

This administrator guide explains how to configure profile source precedence in an organization using Microsoft Graph APIs. It details the steps required to add, update, and delete profile property settings. By following this guide, you can control which profile data is accurately displayed across various Microsoft 365 experiences based on the configured priorities.

The priority source URLs are arranged according to data precedence, with the first item in the collection having the highest priority.

Note: The name property must be empty to differentiate it from other property-level settings in the collection that have a name property. Only one configuration without a name is allowed per profile property settings collection.

Important

Setting a new profile source as a priority changes the values of properties that users in your organization see on their profiles. By default, Entra ID is the prioritized source of profile data in an organization.

Configure profile source precedence settings using the Microsoft Graph API

You can use the profilePropertySetting API to configure profile source precedence in your organization.

Confirm your current settings

Use the List operation to return the current settings for profile property settings in your organization.

The following example gets the collection of profile property settings in an organization.

GET https://graph.microsoft.com/beta/admin/people/profilePropertySettings

If successful, this method returns a 200 OK response code and a profilePropertySetting object in the response body.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": null,
      "userOverridePrivacy": null,
      "allowedAudiences": null,
      "prioritizedSourceUrls": [
        "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='4ce763dd-9214-4eff-af7c-da491cc3782d')"
      ]
    }
  ]
}

Add profile source precedence setting

Use the Create operation to add the profile source precedence setting for your organization.

Request

POST https://graph.microsoft.com/beta/admin/people/profilePropertySettings
Content-Type: application/json

{
  "prioritizedSourceUrls": [
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr1')"
  ]
}

If successful, this method returns a 201 Created response code and a profilePropertySetting object in the response body.

Response

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "00000000-0000-0000-0000-000000000001",
  "name": null,
  "userOverridePrivacy": null,
  "allowedAudiences": null,
  "prioritizedSourceUrls": [
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr1')",
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='4ce763dd-9214-4eff-af7c-da491cc3782d')"
  ]
}

Update profile source precedence setting

Use the Update operation to modify the profile source precedence setting in your organization.

Request

PATCH https://graph.microsoft.com/beta/admin/people/profilePropertySettings/00000000-0000-0000-0000-000000000001
Content-Type: application/json

{
  "prioritizedSourceUrls": [
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr1')",
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr2')"
  ]
}

If successful, this method returns a 200 OK response code and a profilePropertySetting object in the response body.

Response

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "00000000-0000-0000-0000-000000000001",
  "name": null,
  "userOverridePrivacy": null,
  "allowedAudiences": null,
  "prioritizedSourceUrls": [
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr1')",
    "https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='contosohr2')"
  ]
}

Remove profile source precedence setting

Use the Delete operation to remove the profile source precedence setting in your organization.

Request

DELETE https://graph.microsoft.com/beta/admin/people/profilePropertySettings/00000000-0000-0000-0000-000000000001

If successful, this method returns a 204 No Content response code.

Response

HTTP/1.1 204 No Content

Related content