List domains

Namespace: microsoft.graph

Retrieve a list of domain objects.

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

Optional query parameters

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

Note

This API has a known issue related to the $search parameter.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json;

Request body

Don't 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.

Examples

Request

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
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.

CLI

mgc domains list

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

Go

// 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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
domains, 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.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DomainCollectionResponse result = graphClient.domains().get();

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.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->domains()->get()->wait();

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.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.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"
      ]
    }
  ]
}