Domains - List Domains

Service:

Admin

API Version:

v1

Note

This API is in preview.

Returns info for all domains.

This API can be called by a service principal.

Permissions

The caller must have administrator rights such as Office 365 Global administrator or Fabric administrator.

Required Delegated Scopes

Tenant.Read.All or Tenant.ReadWrite.All.

Limitations

Maximum 25 requests per one minute per principal.

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains

With optional parameters:

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}

URI Parameters

Name	In	Required	Type	Description
nonEmptyOnly	query		boolean	When true, only return domains that have at least one workspace that has an item in it. Default: false.

Responses

Name	Type	Description
200 OK	DomainsResponse	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Get all non-empty domains example

Get info for all domains example

Get all non-empty domains example

Sample Request

HTTP

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly=True

Sample Response

Status code:

200

{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": null,
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": null,
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    }
  ]
}

Get info for all domains example

Sample Request

HTTP

GET https://api.fabric.microsoft.com/v1/admin/domains

Sample Response

Status code:

200

{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": null,
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": null,
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    },
    {
      "id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
      "displayName": "AdminsOnly",
      "description": "Admins only",
      "parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
      "displayName": "Root",
      "description": null,
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
      "displayName": "Legal",
      "description": "This domain is used for identifying legal data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    }
  ]
}

Definitions

Name	Description
ContributorsScopeType	The contributor scope. Additional contributor scopes may be added over time.
Domain	Represents a domain or subdomain.
DomainsResponse	This is a response wrapper for a list of all domains.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

ContributorsScopeType

The contributor scope. Additional contributor scopes may be added over time.

Name	Type	Description
AdminsOnly	string	Tenant and domain admins only.
AllTenant	string	All the tenant's users.
SpecificUsersAndGroups	string	Specific users and groups.

Domain

Represents a domain or subdomain.

Name	Type	Description
contributorsScope	ContributorsScopeType	The domain contributors scope.
description	string	The description of the domain.
displayName	string	The name of the domain.
id	string	The domain object ID.
parentDomainId	string	The domain parent object ID.

DomainsResponse

This is a response wrapper for a list of all domains.

Name	Type	Description
domains	Domain[]	The list of domains.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.