Skip to content

domain-list.md

Latest commit

 

History

History
146 lines (112 loc) · 4.47 KB

domain-list.md

File metadata and controls

146 lines (112 loc) · 4.47 KB
title List domains
description Retrieve a list of domain objects.
author tafra00
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 10/25/2024

List domains

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve a list of domain objects.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-domain-apis-read]

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, $top, and $filter query parameters.

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/beta/domains

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE 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,
      "isVerified": true,
      "name": "contoso.com",
      "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline"
      ]
    }
  ]
}