Edit

Share via

Manage profile source settings for an organization using the Microsoft Graph API

Profile source configuration enhances the end-user experience, making the source of their profile data clear and understandable.

This administrator guide explains how to configure profile source settings in an organization using Microsoft Graph APIs. It details the steps required to add, update, and delete a profile source in an organization, ensuring that profile data is accurately attributed and surfaced in various Microsoft 365 experiences.

Important

By default, Microsoft Entra ID is the source of profile data in an organization. An organization administrator sets the sourceId property that is a readable and unique profile source identifier. The sourceId property isn't updateable and can be used as an alternate key when you query for a profile source. A profile source is identifiable via a system-generated key named id.

Admins can customize a profile source display name for multiple locales through the localizations property.

Configure profile source settings using the Microsoft Graph API

You can use the profileSource API to configure a profile source in your organization.

Confirm your current settings

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

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

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

If successful, the response returns a 200 OK response code and a profileSource object in the response body.

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

{
  "value": [
    {
      "id": "27f1af7b-b166-4f5b-b994-ae135a581547",
      "sourceId": "bamboohr1",
      "kind": "BambooHR",
      "displayName": "HR Platform",
      "webUrl": "https://bamboohr.contoso.com/login",
      "localizations": [
        {
          "displayName" : "HR-Platform",
          "webUrl" : "http://bamboohr.contoso.com/en-us/login",
          "languageTag" : "en-us"
        },
        {
          "displayName" : "HR-Plattform",
          "webUrl" : "http://bamboohr.contoso.com/de/login",
          "languageTag" : "de"
        }
      ]
    },
    {
      "id": "520c18f8-0284-4d79-9b14-8a2d74461370",
      "sourceId": "4ce763dd-9214-4eff-af7c-da491cc3782d",
      "kind": "MSEntra",
      "displayName": "Contoso Microsoft Entra",
      "webUrl": "https://login.microsoftonline.com",
      "localizations": [
        {
          "displayName" : "Contoso Microsoft Entra",
          "webUrl" : "https://login.microsoftonline.com",
          "languageTag" : "en-us"
        }
      ]
    }
  ]
}

Add a profile source

Use the Create operation to add a profile source in your organization.

Request

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

{
  "sourceId": "bamboohr1",
  "displayName": "HR Platform",
  "kind": "BambooHR",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

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

Response

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

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "HR Platform",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Update a profile source

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

Request

PATCH https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='bamboohr1')
Content-Type: application/json

{
  "displayName": "BambooHR Updated",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

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

Response

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

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "BambooHR Updated",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Remove a profile source

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

Request

DELETE https://graph.microsoft.com/beta/admin/people/profileSources(sourceId='bamboohr1')

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

Response

HTTP/1.1 204 No Content

Configure profile source settings using the Microsoft Graph PowerShell SDK

You can use the Microsoft Graph PowerShell SDK to configure profile source settings in your organization.

Prerequisites

Note

The PowerShell commands for profile source settings are only available in beta. Switch to the beta experience before you run the following commands.

Install-Module -Name Microsoft.Graph.Beta -MinimumVersion 2.3.0
Update-Module Microsoft.Graph.Beta

Confirm your current settings

To get profile source settings configuration for an organization, use the following command.

Get-MgBetaAdminPeopleProfileSource

To get a profile source setting configuration in an organization, use the following command.

Get-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Note

The get commands require the PeopleSettings.Read.All permission. To create a Microsoft Graph session with a specific required scope, use the following command and consent to the requested permissions.

Connect-MgGraph -Scopes "PeopleSettings.Read.All"

Add a profile source setting in your organization

You can use the Microsoft Graph PowerShell module to configure a profile source setting in your organization. The new command requires the PeopleSettings.ReadWrite.All permission, and to create a Microsoft Graph session with the specific required scope, use the following command and consent to the requested permissions.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

$params = @{
	displayName = "HR-Platform"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

New-MgBetaAdminPeopleProfileSource -BodyParameter $params

Update a profile source setting in your organization

You can use the Microsoft Graph PowerShell module to update a profile source setting in your organization. The update command requires the PeopleSettings.ReadWrite.All permission, and to create a Microsoft Graph session with the specific required scope, use the following command and consent to the requested permissions.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

$params = @{
	displayName = "HR-Platform Updated"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
    @{
      displayName = "HR-Platform"
      webUrl = "http://bamboohr.contoso.com/en-us/login"
      languageTag = "en-us"
    },
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

Update-MgBetaAdminPeopleProfileSource -ProfileSourceId $id -BodyParameter $params

Remove a profile source setting in your organization

You can use the Microsoft Graph PowerShell module to remove a profile source setting from your organization. The remove command requires the PeopleSettings.ReadWrite.All permission, and to create a Microsoft Graph session with the specific required scope, use the following command and consent to the requested permissions.

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

Remove-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Related content

Manage profile source precedence settings for an organization