Update profileSource

2025-06-14

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a profileSource object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	PeopleSettings.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	PeopleSettings.ReadWrite.All	Not available.

Important

To use delegated permissions for this operation, the signed-in user must have the People Administrator role.

HTTP request

PATCH /admin/people/profileSources(sourceId='{sourceId}')

Function parameters

In the request URL, provide the following parameter with a valid value.

Parameter	Type	Description
sourceId	String	Profile source identifier used as an alternate key. Required.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Note: To avoid encoding issues that malform the payload, use Content-Type: application/json; charset=utf-8.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
displayName	String	Name of the profile source intended to inform users about the profile source name.
kind	String	Type of the profile source.
localizations	profileSourceLocalization collection	Alternative localized labels specified by an administrator.
sourceId	String	Profile source identifier used as an alternate key.
webUrl	String	Web URL of the profile source that directs users to the page view of profile data.

Response

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

Examples

Request

The following example shows a request.

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

{
  "@odata.type": "#microsoft.graph.profileSource",
  "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"
    }
  ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new ProfileSource
{
	OdataType = "#microsoft.graph.profileSource",
	SourceId = "bamboohr1",
	Kind = "BambooHR",
	DisplayName = "BambooHR Updated",
	WebUrl = "https://bamboohr.contoso.com/login",
	Localizations = new List<ProfileSourceLocalization>
	{
		new ProfileSourceLocalization
		{
			DisplayName = "HR-Platform",
			WebUrl = "http://bamboohr.contoso.com/en-us/login",
			LanguageTag = "en-us",
		},
		new ProfileSourceLocalization
		{
			DisplayName = "HR-Plattform",
			WebUrl = "http://bamboohr.contoso.com/de/login",
			LanguageTag = "de",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.People.ProfileSourcesWithSourceId("{sourceId}").PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewProfileSource()
sourceId := "bamboohr1"
requestBody.SetSourceId(&sourceId) 
kind := "BambooHR"
requestBody.SetKind(&kind) 
displayName := "BambooHR Updated"
requestBody.SetDisplayName(&displayName) 
webUrl := "https://bamboohr.contoso.com/login"
requestBody.SetWebUrl(&webUrl) 


profileSourceLocalization := graphmodels.NewProfileSourceLocalization()
displayName := "HR-Platform"
profileSourceLocalization.SetDisplayName(&displayName) 
webUrl := "http://bamboohr.contoso.com/en-us/login"
profileSourceLocalization.SetWebUrl(&webUrl) 
languageTag := "en-us"
profileSourceLocalization.SetLanguageTag(&languageTag) 
profileSourceLocalization1 := graphmodels.NewProfileSourceLocalization()
displayName := "HR-Plattform"
profileSourceLocalization1.SetDisplayName(&displayName) 
webUrl := "http://bamboohr.contoso.com/de/login"
profileSourceLocalization1.SetWebUrl(&webUrl) 
languageTag := "de"
profileSourceLocalization1.SetLanguageTag(&languageTag) 

localizations := []graphmodels.ProfileSourceLocalizationable {
	profileSourceLocalization,
	profileSourceLocalization1,
}
requestBody.SetLocalizations(localizations)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
sourceId := "{sourceId}"
profileSources, err := graphClient.Admin().People().ProfileSourcesWithSourceId(&sourceId).Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ProfileSource profileSource = new ProfileSource();
profileSource.setOdataType("#microsoft.graph.profileSource");
profileSource.setSourceId("bamboohr1");
profileSource.setKind("BambooHR");
profileSource.setDisplayName("BambooHR Updated");
profileSource.setWebUrl("https://bamboohr.contoso.com/login");
LinkedList<ProfileSourceLocalization> localizations = new LinkedList<ProfileSourceLocalization>();
ProfileSourceLocalization profileSourceLocalization = new ProfileSourceLocalization();
profileSourceLocalization.setDisplayName("HR-Platform");
profileSourceLocalization.setWebUrl("http://bamboohr.contoso.com/en-us/login");
profileSourceLocalization.setLanguageTag("en-us");
localizations.add(profileSourceLocalization);
ProfileSourceLocalization profileSourceLocalization1 = new ProfileSourceLocalization();
profileSourceLocalization1.setDisplayName("HR-Plattform");
profileSourceLocalization1.setWebUrl("http://bamboohr.contoso.com/de/login");
profileSourceLocalization1.setLanguageTag("de");
localizations.add(profileSourceLocalization1);
profileSource.setLocalizations(localizations);
ProfileSource result = graphClient.admin().people().profileSourcesWithSourceId("{sourceId}").patch(profileSource);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ProfileSource;
use Microsoft\Graph\Beta\Generated\Models\ProfileSourceLocalization;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ProfileSource();
$requestBody->setOdataType('#microsoft.graph.profileSource');
$requestBody->setSourceId('bamboohr1');
$requestBody->setKind('BambooHR');
$requestBody->setDisplayName('BambooHR Updated');
$requestBody->setWebUrl('https://bamboohr.contoso.com/login');
$localizationsProfileSourceLocalization1 = new ProfileSourceLocalization();
$localizationsProfileSourceLocalization1->setDisplayName('HR-Platform');
$localizationsProfileSourceLocalization1->setWebUrl('http://bamboohr.contoso.com/en-us/login');
$localizationsProfileSourceLocalization1->setLanguageTag('en-us');
$localizationsArray []= $localizationsProfileSourceLocalization1;
$localizationsProfileSourceLocalization2 = new ProfileSourceLocalization();
$localizationsProfileSourceLocalization2->setDisplayName('HR-Plattform');
$localizationsProfileSourceLocalization2->setWebUrl('http://bamboohr.contoso.com/de/login');
$localizationsProfileSourceLocalization2->setLanguageTag('de');
$localizationsArray []= $localizationsProfileSourceLocalization2;
$requestBody->setLocalizations($localizationsArray);


$result = $graphServiceClient->admin()->people()->profileSourcesWithSourceId('{sourceId}', )->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	"@odata.type" = "#microsoft.graph.profileSource"
	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"
		}
	)
}

Update-MgBetaAdminPeopleProfileSourceBySourceId -BodyParameter $params -SourceId $sourceIdId

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.profile_source import ProfileSource
from msgraph_beta.generated.models.profile_source_localization import ProfileSourceLocalization
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ProfileSource(
	odata_type = "#microsoft.graph.profileSource",
	source_id = "bamboohr1",
	kind = "BambooHR",
	display_name = "BambooHR Updated",
	web_url = "https://bamboohr.contoso.com/login",
	localizations = [
		ProfileSourceLocalization(
			display_name = "HR-Platform",
			web_url = "http://bamboohr.contoso.com/en-us/login",
			language_tag = "en-us",
		),
		ProfileSourceLocalization(
			display_name = "HR-Plattform",
			web_url = "http://bamboohr.contoso.com/de/login",
			language_tag = "de",
		),
	],
)

result = await graph_client.admin.people.profile_sources_with_source_id("{sourceId}").patch(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.type": "#microsoft.graph.profileSource",
  "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"
    }
  ]
}

Share via

Update profileSource

Permissions

HTTP request

Function parameters

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources