Skip to content

domain-verify.md

Latest commit

 

History

History
137 lines (102 loc) · 5.08 KB

domain-verify.md

File metadata and controls

137 lines (102 loc) · 5.08 KB
title domain: verify
description Validate the ownership of a domain.
author tafra00
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 10/31/2024

domain: verify

Namespace: microsoft.graph

Validate the ownership of a domain. This operation only applies to an unverified domain. For an unverified domain, the isVerified property is false.

Note

Verifying a domain through Microsoft Graph doesn't configure the domain for use with Office 365 services like Exchange. Fully configuring the domain to work with Microsoft 365 products might require extra steps. For more information, see Microsoft 365 admin setup.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-domain-apis-write]

HTTP request

POST /domains/{id}/verify

For {id}, specify the domain with its fully qualified domain name.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

Request body

In the request body, supply a JSON representation of the parameters.

The following table lists the parameters that are optional when you call this action.

Parameter Type Description
forceTakeover Boolean Optional. Used for external admin takeover of an unmanaged domain. The default value for this parameter is false.

If the domain to be verified is currently linked to an unmanaged tenant but you own the domain, use this parameter to take over that domain. Force takeover only succeeds when this tenant has verified their ownership of the domain by adding the TXT records to the domain registrar. For more information, see Take over an unmanaged directory as administrator in Microsoft Entra ID.

Response

If successful, this method returns 200 OK response code and domain object in the response body.

Example

Request

HTTP

POST https://graph.microsoft.com/v1.0/domains/{domain-name}/verify

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "authenticationType": "authenticationType-value",
  "availabilityStatus": "availabilityStatus-value",
  "isAdminManaged": true,
  "isDefault": true,
  "isInitial": true,
  "isRoot": true,
  "id": "contoso.com"
}