Namespace: microsoft.graph
Update the properties of a externalUserProfile 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) |
ExternalUserProfile.ReadWrite.All |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
ExternalUserProfile.ReadWrite.All |
Not available. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:
- Extended Directory User Administrator
- Teams Service Administrator
HTTP request
PATCH /directory/externalUserProfiles/{id}
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.
PATCH https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
Content-Type: application/json
{
"jobTitle": "Contractor"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new ExternalUserProfile
{
JobTitle = "Contractor",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Directory.ExternalUserProfiles["{externalUserProfile-id}"].PatchAsync(requestBody);
// 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.NewExternalUserProfile()
jobTitle := "Contractor"
requestBody.SetJobTitle(&jobTitle)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
externalUserProfiles, err := graphClient.Directory().ExternalUserProfiles().ByExternalUserProfileId("externalUserProfile-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
ExternalUserProfile externalUserProfile = new ExternalUserProfile();
externalUserProfile.setJobTitle("Contractor");
ExternalUserProfile result = graphClient.directory().externalUserProfiles().byExternalUserProfileId("{externalUserProfile-id}").patch(externalUserProfile);
const options = {
authProvider,
};
const client = Client.init(options);
const externalUserProfile = {
jobTitle: 'Contractor'
};
await client.api('/directory/externalUserProfiles/{id}')
.version('beta')
.update(externalUserProfile);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\ExternalUserProfile;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ExternalUserProfile();
$requestBody->setJobTitle('Contractor');
$result = $graphServiceClient->directory()->externalUserProfiles()->byExternalUserProfileId('externalUserProfile-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement
$params = @{
jobTitle = "Contractor"
}
Update-MgBetaDirectoryExternalUserProfile -ExternalUserProfileId $externalUserProfileId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.external_user_profile import ExternalUserProfile
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ExternalUserProfile(
job_title = "Contractor",
)
result = await graph_client.directory.external_user_profiles.by_external_user_profile_id('externalUserProfile-id').patch(request_body)
Response
The following example shows the response.
HTTP/1.1 204 No Content