Namespace: microsoft.graph
Update the properties of domain object. Only verified domains can be updated.
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) |
Domain.ReadWrite.All |
Directory.AccessAsUser.All |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Domain.ReadWrite.All |
Not available. |
Important
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. The following least privileged roles are supported for this operation.
- Domain Name Administrator
- Security Administrator
- External Identity Provider Administrator
HTTP request
PATCH /domains/{id}
For {id}, specify the domain with its fully qualified domain name.
Request body
In the request body, supply the values for relevant fields to be updated. Existing properties not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, only include changed values.
Response
If successful, this method returns a 204 No Content response code and no response body.
Example
Request
PATCH https://graph.microsoft.com/v1.0/domains/contoso.com
Content-type: application/json
{
"isDefault": true,
"supportedServices": [
"Email",
"OfficeCommunicationsOnline"
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new Domain
{
IsDefault = true,
SupportedServices = new List<string>
{
"Email",
"OfficeCommunicationsOnline",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains["{domain-id}"].PatchAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc domains patch --domain-id {domain-id} --body '{\
"isDefault": true,\
"supportedServices": [\
"Email",\
"OfficeCommunicationsOnline"\
]\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewDomain()
isDefault := true
requestBody.SetIsDefault(&isDefault)
supportedServices := []string {
"Email",
"OfficeCommunicationsOnline",
}
requestBody.SetSupportedServices(supportedServices)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
domains, err := graphClient.Domains().ByDomainId("domain-id").Patch(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
Domain domain = new Domain();
domain.setIsDefault(true);
LinkedList<String> supportedServices = new LinkedList<String>();
supportedServices.add("Email");
supportedServices.add("OfficeCommunicationsOnline");
domain.setSupportedServices(supportedServices);
Domain result = graphClient.domains().byDomainId("{domain-id}").patch(domain);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const domain = {
isDefault: true,
supportedServices: [
'Email',
'OfficeCommunicationsOnline'
]
};
await client.api('/domains/contoso.com')
.update(domain);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Domain;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new Domain();
$requestBody->setIsDefault(true);
$requestBody->setSupportedServices(['Email', 'OfficeCommunicationsOnline', ]);
$result = $graphServiceClient->domains()->byDomainId('domain-id')->patch($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
isDefault = $true
supportedServices = @(
"Email"
"OfficeCommunicationsOnline"
)
}
Update-MgDomain -DomainId $domainId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.domain import Domain
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Domain(
is_default = True,
supported_services = [
"Email",
"OfficeCommunicationsOnline",
],
)
result = await graph_client.domains.by_domain_id('domain-id').patch(request_body)
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 No Content