Edit

Share via

Domains - Get Domain (preview)

Service:
Admin
API Version:
v1

Returns the specified domain info (preview).

Note

This preview API will be deprecated on March 31, 2026, and replaced by a stable version, available here. The new version introduces breaking changes and is not backward compatible. When calling this API, callers must specify true as the value for the query parameter preview.

Deprecation Notice

A new query parameter preview has been introduced to facilitate this transition:

  • The preview query parameter currently defaults to true.
  • Set the value of the preview query parameter to false to use the Release version of this API.
  • Starting March 31, 2026, the default value for preview will change to false.

It is recommended to migrate your integration to use the Release version as soon as possible by specifying false for the preview query parameter (the default value for the preview query parameter will be set to false on API's deprecation date).

The following incompatible changes were introduced in the Release version:

  • Response property contributorsScope was removed.

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

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

Limitations

Maximum 25 requests per one minute per principal.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
domainId
 path True

string (uuid)

The domain ID.
preview
 query True

boolean

This parameter specifies which version of the API to use. Set to true to use the preview version described on this page, or to false to use the Release version detailed here. Starting March 31, 2026, the default value for preview will change to false.

Responses

Name Type Description
200 OK

DomainPreview

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • DomainNotFound - The provided domain was not found

  • UnknownError - An error occurred.

Examples

Get a domain example

Sample request

GET https://api.fabric.microsoft.com/v1/admin/domains/f2f6a374-789e-4d1d-9cc7-6e0b934fc529?preview=True

Sample response

Status code:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Definitions

Name Description
ContributorsScopeType

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

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

ContributorsScopeType

Enumeration

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

Value Description
AllTenant

All the tenant's users.
SpecificUsersAndGroups

Specific users and groups.
AdminsOnly

Tenant and domain admins only.

DomainPreview

Object
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 (uuid)

The domain object ID.
parentDomainId

string (uuid)

The domain parent object ID.

ErrorRelatedResource

Object

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

Object

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

Object

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.