Domains - Get Domain

Service:

Admin

API Version:

v1

Note

This API is in preview.

Returns the specified domain info.

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/{domainId}

URI Parameters

Name	In	Required	Type	Description
domainId	path	True	string uuid	The domain ID.

Responses

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

Examples

Get a domain example

Sample Request

HTTP

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

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.
Domain	Represents a domain or subdomain.
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.

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.