Force domain deletion
Namespace: microsoft.graph
Deletes a domain using an asynchronous long-running operation.
Prior to calling forceDelete, you must update or remove any references to Exchange as the provisioning service.
The following actions are performed as part of this operation:
Updates the
userPrincipalName
,mail
, andproxyAddresses
properties ofusers
with references to the deleted domain to use the initial onmicrosoft.com domain.Updates the
mail
property ofgroups
with references to the deleted domain to use the initial onmicrosoft.com domain.Updates the
identifierUris
property ofapplications
with references to the deleted domain to use the initial onmicrosoft.com domain.If the number of objects to be renamed is greater than 1000, an error is returned.
If one of the
applications
to be renamed is a multi-tenant app, an error is returned.
After the domain deletion completes, API operations for the deleted domain will return a HTTP 404 status code. To verify deletion of a domain, you can perform a get domain operation.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Domain.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Domain.ReadWrite.All |
The work or school account needs to belong to one of the following roles:
- Global Administrator
- Domain Name Administrator
- Partner Tier2 Support
HTTP request
POST /domains/{id}/forceDelete
For {id}, specify the domain with its fully qualified domain name.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json |
Request body
In the request body, provide a JSON object with the following parameters.
Parameter | Type | Description |
---|---|---|
disableUserAccounts |
Boolean |
Option to disable user accounts which are renamed. If a user account is disabled, the user will not be allowed to sign in. If set to true the users updated as part of this operation will be disabled. Default value is true. |
Response body
If successful, this method returns HTTP/1.1 204 OK
status code.
Example
Request
POST https://graph.microsoft.com/v1.0/domains/{id}/forceDelete
Content-type: application/json
{
"disableUserAccounts": true
}
Response
HTTP/1.1 204 OK
Feedback
Submit and view feedback for