Update profileSource

Namespace: microsoft.graph

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 permissions	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 the 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/v1.0/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"
    }
  ]
}

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"
    }
  ]
}