ESC
Type to search...

Domain.Read.All

Export JSON
Export CSV
Copy URL
Print
ApplicationDelegated Read All Resources

Allows the app to read all domain properties without a signed-in user.

Delegated Access App-Only Access

Permission Details

Application Permission

Read domains

Allows the app to read all domain properties without a signed-in user.

Delegated Permission Admin consent required

Read domains.

Allows the app to read all domain properties on behalf of the signed-in user.

Properties

Property Type Description
id string The unique identifier for an entity. Read-only.
isAdminManaged boolean The value of the property is false if the DNS record management of the domain is delegated to Microsoft 365. Otherwise, the value is true. Not nullable.
verificationDnsRecords microsoft.graph.domainDnsRecord 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. Does not support $expand.
federationConfiguration microsoft.graph.internalDomainFederation collection Domain settings configured by customer when federated with Microsoft Entra ID. Does not support $expand.
isInitial boolean true for the initial domain created by Microsoft Online Services. For example, contoso.onmicrosoft.com. There's only one initial domain per company. Not nullable.
isRoot boolean true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable.
domainNameReferences microsoft.graph.directoryObject collection The objects such as users and groups that reference the domain ID. Read-only, Nullable. Does not 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.
isVerified boolean true for verified domains. Not nullable.
authenticationType string Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Microsoft Entra ID performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. To update this property in delegated scenarios, the calling app must be assigned the Domain-InternalFederation.ReadWrite.All permission.
serviceConfigurationRecords microsoft.graph.domainDnsRecord 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. Does not support $expand.
availabilityStatus stringNullable This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.
passwordNotificationWindowInDays int32Nullable Specifies the number of days before a user receives a password expiry notification. 14 days by default.
state object Status of asynchronous operations scheduled for the domain.
sharedEmailDomainInvitations microsoft.graph.sharedEmailDomainInvitation collection
passwordValidityPeriodInDays int32Nullable Specifies the length of time that a password is valid before it must be changed. 90 days by default.

Showing 15 of 18 properties. View all on Microsoft Learn →

JSON Representation

JSON representation
{
  "id": "String",
  "isAdminManaged": "Boolean",
  "verificationDnsRecords": "[...]",
  "federationConfiguration": "[...]",
  "isInitial": "Boolean",
  "isRoot": "Boolean",
  "domainNameReferences": "[...]",
  "isVerified": "Boolean",
  "authenticationType": "String",
  "serviceConfigurationRecords": "[...]",
  "availabilityStatus": "String",
  "passwordNotificationWindowInDays": "Int32",
  "state": "{...}",
  "sharedEmailDomainInvitations": "[...]",
  "passwordValidityPeriodInDays": "Int32",
  "supportedServices": "array",
  "rootDomain": "{...}",
  "isDefault": "Boolean"
}

Relationships

Relationship Type Description
domainNameReferences directoryObject collection The objects such as users and groups that reference the domain ID. Read-only, Nullable.
federationConfiguration internalDomainFederation collection Domain settings configured by a customer when federated with Azure AD.
serviceConfigurationRecords domainDnsRecord collection DNS records the customer adds to the DNS zone file of the domain.
verificationDnsRecords domainDnsRecord collection DNS records that the customer adds to the DNS zone file of the domain.

Graph Methods

Delegated access App-only access
Methods
GET /directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation
GET /directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation?$filter=domains/any(x: x/id eq 'domainName-value')
GET /domains
GET /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}
GET /domains/{id}
GET /domains/{id}/domainNameReferences
GET /domains/{id}/rootDomain
GET /domains/{id}/serviceConfigurationRecords
GET /domains/{id}/verificationDnsRecords
Methods
GET /directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation
GET /directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation?$filter=domains/any(x: x/id eq 'domainName-value')
GET /domains
GET /domains/{domainsId}/federationConfiguration/{internalDomainFederationId}
GET /domains/{id}
GET /domains/{id}/domainNameReferences
GET /domains/{id}/serviceConfigurationRecords
GET /domains/{id}/verificationDnsRecords
GET /domains/contoso.com/rootDomain

Code Examples

C# / .NET SDK
// Install: dotnet add package Microsoft.Graph
// Install: dotnet add package Azure.Identity
using Microsoft.Graph;
using Azure.Identity;

// Delegated permissions - interactive user sign-in
var scopes = new[] { "Domain.Read.All" };
var options = new InteractiveBrowserCredentialOptions
{
    ClientId = "YOUR_CLIENT_ID",
    TenantId = "YOUR_TENANT_ID",
    RedirectUri = new Uri("http://localhost")
};
var credential = new InteractiveBrowserCredential(options);
var graphClient = new GraphServiceClient(credential, scopes);

// Example: GET /me
var result = await graphClient.Me.GetAsync();
Console.WriteLine($"User: {result?.DisplayName}");

// Application permissions - daemon/service app
var tenantId = "YOUR_TENANT_ID";
var clientId = "YOUR_CLIENT_ID";
var clientSecret = "YOUR_CLIENT_SECRET";

var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
var graphClient = new GraphServiceClient(credential);

// Example: GET /users/{user-id}
var users = await graphClient.Users.GetAsync();
foreach (var user in users?.Value ?? [])
{
    Console.WriteLine($"User: {user.DisplayName}");
}
JavaScript / TypeScript
// npm install @azure/msal-browser @microsoft/microsoft-graph-client
import { PublicClientApplication } from "@azure/msal-browser";
import { Client } from "@microsoft/microsoft-graph-client";
import { AuthCodeMSALBrowserAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/authCodeMsalBrowser";

const msalConfig = {
    auth: {
        clientId: "YOUR_CLIENT_ID",
        authority: "https://login.microsoftonline.com/YOUR_TENANT_ID"
    }
};

const pca = new PublicClientApplication(msalConfig);
await pca.initialize();

// Delegated: Login with required scope
const loginResponse = await pca.loginPopup({
    scopes: ["Domain.Read.All"]
});

const authProvider = new AuthCodeMSALBrowserAuthenticationProvider(pca, {
    account: loginResponse.account,
    scopes: ["Domain.Read.All"],
    interactionType: "popup"
});

const graphClient = Client.initWithMiddleware({ authProvider });

// Example: GET /me
const result = await graphClient.api("/me").get();
console.log(result);

// Application: Use client credentials (Node.js backend only)
// npm install @azure/identity @microsoft/microsoft-graph-client
import { ClientSecretCredential } from "@azure/identity";
import { TokenCredentialAuthenticationProvider } from 
    "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

const credential = new ClientSecretCredential(
    "YOUR_TENANT_ID",
    "YOUR_CLIENT_ID", 
    "YOUR_CLIENT_SECRET"
);

const authProvider = new TokenCredentialAuthenticationProvider(credential, {
    scopes: ["https://graph.microsoft.com/.default"]
});

const graphClient = Client.initWithMiddleware({ authProvider });
const result = await graphClient.api("/users").get();
console.log(result);
PowerShell
# Install Microsoft Graph PowerShell module
Install-Module Microsoft.Graph -Scope CurrentUser

# Delegated access - interactive sign-in
Connect-MgGraph -Scopes "Domain.Read.All"

# Verify connection
Get-MgContext | Select-Object Account, TenantId, Scopes

# Example: GET /me
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/me"
$result | ConvertTo-Json -Depth 5

# Application access with certificate
$params = @{
    ClientId = "YOUR_CLIENT_ID"
    TenantId = "YOUR_TENANT_ID"
    CertificateThumbprint = "YOUR_CERT_THUMBPRINT"
}
Connect-MgGraph @params

# Or with client secret (not recommended for production)
# Connect-MgGraph -ClientSecretCredential $credential

# Example: GET /users
$result = Invoke-MgGraphRequest -Method GET -Uri "https://graph.microsoft.com/v1.0/users"
$result | ConvertTo-Json -Depth 5

# Always disconnect when done
Disconnect-MgGraph
Python
# pip install msgraph-sdk azure-identity
from azure.identity import InteractiveBrowserCredential, ClientSecretCredential
from msgraph import GraphServiceClient
import asyncio

# Delegated permissions - interactive browser sign-in
credential = InteractiveBrowserCredential(
    client_id="YOUR_CLIENT_ID",
    tenant_id="YOUR_TENANT_ID"
)
scopes = ["Domain.Read.All"]
client = GraphServiceClient(credential, scopes)

async def get_data():
    # Example: GET /me
    result = await client.me.get()
    print(f"User: {result.display_name}")
    return result

asyncio.run(get_data())

# Application permissions - client credentials
credential = ClientSecretCredential(
    tenant_id="YOUR_TENANT_ID",
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET"
)
scopes = ["https://graph.microsoft.com/.default"]
client = GraphServiceClient(credential, scopes)

async def get_users():
    # Example: GET /users
    result = await client.users.get()
    for user in result.value:
        print(f"User: {user.display_name}")
    return result

asyncio.run(get_users())

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or Delegated permissions and search for Domain.Read.All

4

Grant Admin Consent

Application permissions always require admin consent. Click "Grant admin consent" in the Azure portal.