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 |
The work or school account needs to belong to one of the following Microsoft Entra roles:
- 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
GET https://graph.microsoft.com/v1.0/domains
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"
]
}
]
}