Modifica

Condividi tramite

Get rootDomain

  • Articolo

Namespace: microsoft.graph

Get the root domain of a subdomain.

This API returns a single object.

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.Read.All Directory.Read.All, Domain.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Domain.Read.All Directory.Read.All, Domain.ReadWrite.All

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.

  • User Administrator
  • Helpdesk Administrator
  • Service Support Administrator
  • Billing Administrator
  • Mailbox Administrator
  • Directory Readers
  • Directory Writers
  • AdHoc License Administrator
  • Application Administrator
  • Security Reader
  • Security Administrator
  • Privileged Role Administrator
  • Cloud Application Administrator
  • Customer LockBox Access Approver
  • Dynamics 365 Administrator
  • Power BI Administrator
  • Azure Information Protection Administrator
  • Desktop Analytics Administrator
  • License Administrator
  • Microsoft Managed Desktop Administrator
  • Privileged Authentication Administrator
  • Teams Communications Administrator
  • Teams Communications Support Engineer
  • Authentication Administrator
  • Teams Communications Support Specialist
  • Teams Administrator
  • Insights Administrator
  • Compliance Data Administrator
  • Security Operator
  • Kaizala Administrator
  • Global Reader
  • Volume Licensing Business Center User
  • Volume Licensing Service Center User
  • Modern Commerce Administrator
  • Microsoft Store for Business User
  • Directory Reviewer
  • Domain Name Administrator
  • Users
  • Guest User
  • Restricted Guest User

HTTP request

GET /domains/{id}/rootDomain

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

Optional query parameters

This method does not support OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/domains/sub.contoso.com/rootDomain

Response

The following example shows the response.

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

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

{
  "value":
    {
      "@odata.type": "#microsoft.graph.domain",
      "id": "contoso.com",
      "authenticationType": "Managed",
      "availabilityStatus": null,
      "isAdminManaged": true,
      "isDefault": true,
      "isInitial": true,
      "isRoot": true,
      "isVerified": true,
      "passwordNotificationWindowInDays": 14,
      "passwordValidityPeriodInDays": 2147483647,
      "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
      ],
      "state": null
    }
}