Skip to content

Commit 014d8d7

Browse files
authored
Merge pull request #25117 from microsoftgraph/AddRootDomainToV1
Add root domain to v1.0 domain entity
2 parents 1580328 + 23a749a commit 014d8d7

File tree

4 files changed

+153
-1
lines changed

4 files changed

+153
-1
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "Get rootDomain"
3+
description: "Get the root domain of a subdomain."
4+
author: "shilpi-kansal"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-directory-management"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get rootDomain
11+
12+
Namespace: microsoft.graph
13+
14+
Get the [root domain](../resources/domain.md) of a subdomain.
15+
16+
This API returns a single object.
17+
18+
## Permissions
19+
20+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
21+
22+
<!-- { "blockType": "permissions", "name": "domain_get_rootdomain" } -->
23+
[!INCLUDE [permissions-table](../includes/permissions/domain-get-rootdomain-permissions.md)]
24+
25+
## HTTP request
26+
27+
<!-- {
28+
"blockType": "ignored"
29+
}
30+
-->
31+
``` http
32+
GET /domains/{id}/rootDomain
33+
```
34+
> For {id}, specify the domain with its fully qualified domain name.
35+
36+
## Optional query parameters
37+
38+
This method does not support OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
39+
40+
## Request headers
41+
42+
|Name|Description|
43+
|:---|:---|
44+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
45+
46+
## Request body
47+
48+
Don't supply a request body for this method.
49+
50+
## Response
51+
52+
If successful, this method returns a `200 OK` response code and a [domain](../resources/domain.md) object in the response body.
53+
54+
## Examples
55+
56+
### Request
57+
58+
The following example shows a request.
59+
<!-- {
60+
"blockType": "request",
61+
"sampleKeys": ["sub.contoso.com"],
62+
"name": "get_rootDomain"
63+
}
64+
-->
65+
``` http
66+
GET https://graph.microsoft.com/v1.0/domains/sub.contoso.com/rootDomain
67+
```
68+
69+
### Response
70+
71+
The following example shows the response.
72+
>**Note:** The response object shown here might be shortened for readability.
73+
<!-- {
74+
"blockType": "response",
75+
"truncated": true,
76+
"@odata.type": "microsoft.graph.domain"
77+
}
78+
-->
79+
``` http
80+
HTTP/1.1 200 OK
81+
Content-Type: application/json
82+
83+
{
84+
"value":
85+
{
86+
"@odata.type": "#microsoft.graph.domain",
87+
"id": "contoso.com",
88+
"authenticationType": "Managed",
89+
"availabilityStatus": null,
90+
"isAdminManaged": true,
91+
"isDefault": true,
92+
"isInitial": true,
93+
"isRoot": true,
94+
"isVerified": true,
95+
"passwordNotificationWindowInDays": 14,
96+
"passwordValidityPeriodInDays": 2147483647,
97+
"supportedServices": [
98+
"Email",
99+
"OfficeCommunicationsOnline"
100+
],
101+
"state": null
102+
}
103+
}
104+
```
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|Domain.Read.All|Directory.Read.All, Domain.ReadWrite.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|Domain.Read.All|Directory.Read.All, Domain.ReadWrite.All|
12+

api-reference/v1.0/resources/domain.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ To associate a domain with a tenant:
3434
|[List](../api/domain-list.md) | [domain](domain.md) | Retrieve all domains linked to the tenant. |
3535
|[Create](../api/domain-post-domains.md) | [domain](domain.md) | Adds a domain to the tenant. |
3636
|[Get](../api/domain-get.md) | [domain](domain.md) | Read properties and relationships of a domain object.|
37+
|[Get root domain](../api/domain-get-rootdomain.md) | [domain](domain.md) | Get the root domain of a subdomain.|
3738
|[Update](../api/domain-update.md) | [domain](domain.md) |Updates a domain.|
3839
|[Delete](../api/domain-delete.md) | None |Deletes a domain.|
3940
|[Force delete](../api/domain-forcedelete.md)|None|Deletes a domain using an asynchronous operation.|
@@ -67,9 +68,10 @@ Relationships between a domain and other objects in the directory such as its ve
6768
| Relationship | Type |Description|
6869
|:---------------|:--------|:----------|
6970
|domainNameReferences|[directoryObject](directoryobject.md) collection| The objects such as users and groups that reference the domain ID. Read-only, Nullable. Doesn't support `$expand`. Supports `$filter` by the OData type of objects returned. For example, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` and `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.|
71+
|federationConfiguration|[internalDomainFederation](internaldomainfederation.md)| Domain settings configured by a customer when federated with Microsoft Entra ID. Doesn't support `$expand`.|
72+
|rootDomain|[domain](domain.md)| Root domain of a subdomain. Read-only, Nullable. Supports `$expand`.|
7073
|serviceConfigurationRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support `$expand`. |
7174
|verificationDnsRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Doesn't support `$expand`.|
72-
|federationConfiguration|[internalDomainFederation](internaldomainfederation.md)| Domain settings configured by a customer when federated with Microsoft Entra ID. Doesn't support `$expand`.|
7375

7476
## JSON representation
7577
The following JSON representation shows the resource type.

changelog/Microsoft.DirectoryServices.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13627,6 +13627,40 @@
1362713627
"CreatedDateTime": "2024-09-11T18:27:13.3184952Z",
1362813628
"WorkloadArea": "Identity and access",
1362913629
"SubArea": "Directory management"
13630+
},
13631+
{
13632+
"ChangeList": [
13633+
{
13634+
"Id": "97e80cb9-b4af-40a3-94ee-d4d85aabc440",
13635+
"ApiChange": "Relationship",
13636+
"ChangedApiName": "rootDomain",
13637+
"ChangeType": "Addition",
13638+
"Description": "Added the **rootDomain** relationship to the [domain](https://learn.microsoft.com/en-us/graph/api/resources/domain?view=graph-rest-1.0) resource.",
13639+
"Target": "domain"
13640+
},
13641+
{
13642+
"Id": "97e80cb9-b4af-40a3-94ee-d4d85aabc440",
13643+
"ApiChange": "Method",
13644+
"ChangedApiName": "GET",
13645+
"ChangeType": "Addition",
13646+
"Description": "Added the [Get rootDomain](https://learn.microsoft.com/en-us/graph/api/domain-get-rootdomain?view=graph-rest-1.0) operation to the [domain](https://learn.microsoft.com/en-us/graph/api/resources/domain?view=graph-rest-1.0) resource.",
13647+
"Target": "domain"
13648+
},
13649+
{
13650+
"Id": "97e80cb9-b4af-40a3-94ee-d4d85aabc440",
13651+
"ApiChange": "NavigationPropertyBinding",
13652+
"ChangedApiName": "rootDomain",
13653+
"ChangeType": "Addition",
13654+
"Description": "Added the [rootDomain](https://learn.microsoft.com/en-us/?view=graph-rest-1.0) resource",
13655+
"Target": "domains"
13656+
}
13657+
],
13658+
"Id": "97e80cb9-b4af-40a3-94ee-d4d85aabc440",
13659+
"Cloud": "Review",
13660+
"Version": "v1.0",
13661+
"CreatedDateTime": "2024-10-09T23:15:04.1920065Z",
13662+
"WorkloadArea": "Identity and access",
13663+
"SubArea": "Directory management"
1363013664
}
1363113665
]
1363213666
}

0 commit comments

Comments
 (0)