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, and proxyAddresses properties of users with references to the deleted domain to use the initial onmicrosoft.com domain.

• Updates the mail property of groups with references to the deleted domain to use the initial onmicrosoft.com domain.

• Updates the identifierUris property of applications 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

HTTP

POST https://graph.microsoft.com/v1.0/domains/{id}/forceDelete
Content-type: application/json

{
  "disableUserAccounts": true
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Domains.Item.ForceDelete.ForceDeletePostRequestBody
{
	DisableUserAccounts = true,
};
await graphClient.Domains["{domain-id}"].ForceDelete.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const forceDelete = {
  disableUserAccounts: true
};

await client.api('/domains/{id}/forceDelete')
	.post(forceDelete);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Boolean disableUserAccounts = true;

graphClient.domains("{id}")
	.forceDelete(DomainForceDeleteParameterSet
		.newBuilder()
		.withDisableUserAccounts(disableUserAccounts)
		.build())
	.buildRequest()
	.post();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/Domains/Item/ForceDelete"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewForceDeletePostRequestBody()
disableUserAccounts := true
requestBody.SetDisableUserAccounts(&disableUserAccounts) 

graphClient.DomainsById("domain-id").ForceDelete().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	DisableUserAccounts = $true
}

Invoke-MgForceDomainDelete -DomainId $domainId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new ForceDeletePostRequestBody();
$requestBody->setDisableUserAccounts(true);



$graphServiceClient->domainsById('domain-id')->forceDelete()->post($requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

HTTP/1.1 204 OK