List domains

Namespace: microsoft.graph

Retrieve a list of domain objects.

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

The work or school account needs to belong to one of the following roles:

• Global Administrator
• User Administrator
• Helpdesk Administrator
• Service Support Administrator
• Billing Administrator
• Mailbox Administrator
• Partner Tier1 Support
• Partner Tier2 Support
• 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 User
• Microsoft Store for Business User
• Directory Reviewer
• Domain Name Administrator
• Users
• Guest User
• Restricted Guest User

HTTP request

GET /domains

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Accept	application/json;

Request body

Do not supply a request body for this method.

Response

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

Example

Request

HTTP

GET https://graph.microsoft.com/v1.0/domains

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Domains.GetAsync();

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);

let domains = await client.api('/domains')
	.get();

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();

DomainCollectionPage domains = graphClient.domains()
	.buildRequest()
	.get();

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
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


result, err := graphClient.Domains().Get(context.Background(), 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

Get-MgDomain

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);


$requestResult = $graphServiceClient->domains()->get();

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

Response

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

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

{
  "value": [
    {
      "authenticationType": "authenticationType-value",
      "availabilityStatus": "availabilityStatus-value",
      "isAdminManaged": true,
      "isDefault": true,
      "isInitial": true,
      "isRoot": true,
      "id": "contoso.com",
      "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
      ]
    }
  ]
}