Update externalUserProfile
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. |
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. Teams Service Administrator is the least privileged role supported for this operation.
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.
PATCH https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
Content-Type: application/json
{
"jobTitle": "Contractor"
}
Response
The following example shows the response.
HTTP/1.1 204 No Content