domain: forceDelete

Deletes a domain using an asynchronous operation.

The following actions are performed as part of this operation:

  • Renames the UPN, EmailAddress, and ProxyAddress of users with references to the deleted domain.

  • Renames the EmailAddress of groups with references to the deleted domain.

  • Renames the identifierUris of applications with references to the deleted domain.

  • If the number of objects to be renamed is greater than 100, 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 404 HTTP response code. To verify deletion of a domain, you can perform a get domain. If the domain was successfully deleted, a 404 HTTP response code will be returned in the response.

Prerequisites

One of the following scopes are required to execute this API: Domain.ReadWrite.All or Directory.AccessAsUser.All

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 renamed user accounts. If a user account is disabled, the user will not be allowed to sign in.
True (default) - User accounts renamed as part of this operation are disabled.
False - User accounts renamed as part of this operation are not disabled.

Response

If successful, this method returns 200, OK response code.

Example

Request
POST https://graph.microsoft.com/beta/domains/contoso.com/forceDelete
Content-type: application/json
Content-length: 33

{
  "disableUserAccounts": true
}
Response
HTTP/1.1 200 OK