Update externalIdentitiesPolicy
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 settings of the tenant-wide externalIdentitiesPolicy object that controls whether external users can leave a Microsoft Entra tenant via self-service controls.
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) | Policy.ReadWrite.ExternalIdentities | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Policy.ReadWrite.ExternalIdentities | Not available. |
HTTP request
PATCH /policies/externalIdentitiesPolicy
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 only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property | Type | Description |
---|---|---|
allowDeletedIdentitiesDataRemoval | Boolean | Reserved for future use. |
allowExternalIdentitiesToLeave | Boolean | Defines whether external users can leave the guest tenant. If set to false , self-service controls are disabled, and the admin of the guest tenant must manually remove the external user from the guest tenant. When the external user leaves the tenant, their data in the guest tenant is first soft-deleted then permanently deleted in 30 days. Required. |
Response
If successful, this method returns a 204 No Content
response code. It doesn't return anything in the response body.
Examples
Request
PATCH https://graph.microsoft.com/beta/policies/externalIdentitiesPolicy
{
"allowExternalIdentitiesToLeave":false
}
Response
HTTP/1.1 204 No Content
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for