Skip to content

externaluserprofile-update.md

Latest commit

 

History

History
141 lines (103 loc) · 4.95 KB

externaluserprofile-update.md

File metadata and controls

141 lines (103 loc) · 4.95 KB
title Update externalUserProfile
description Update the properties of a externalUserProfile object.
author jkdouglas
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 10/11/2024

Update externalUserProfile

Namespace: microsoft.graph

Update the properties of a externalUserProfile object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-externaluserprofiles-apis-write]

HTTP request

PATCH /directory/externalUserProfiles/{id}

Request headers

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

Request body

In the request body, supply a JSON representation of the externalUserProfile object.

The following table shows the properties that are able to be updated after a pendingExternalUserProfile is redeemed and converted to an externalUserProfile.

Property Type Description
address physicalOfficeAddress The office address of the pending external user profile.
companyName String The company name of the pending external user profile.
department String The department of the pending external user profile.
displayName String The display name of the pending external user profile.
isDiscoverable Boolean Represents whether the pending external user profile is discoverable in the directory.
isEnabled Boolean Represents whether the pending external user profile is enabled in the directory.
jobTitle String The job title of the external user profile.
supervisorId String The object id of the supervisor of the pending external user profile.

Response

If successful, this method returns a 204 No Content response code and an updated externalUserProfile object in the response body.

Example

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
Content-Type: application/json

{
  "jobTitle": "Contractor"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 204 No Content