Domains - Update Domain

Service:

Admin

API Version:

v1

Note

This API is in preview.

Updates the specified domain info.

Permissions

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

Required Delegated Scopes

Tenant.ReadWrite.All.

Limitations

Maximum 25 requests per one minute per principal.

Interface

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}

URI Parameters

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

Request Body

Name	Type	Description
contributorsScope	ContributorsScopeType	The domain contributors scope.
description	string	The domain description. The description cannot contain more than 256 characters.
displayName	string	The domain display name. The display name cannot contain more than 40 characters.

Responses

Name	Type	Description
200 OK	Domain	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred. EntityConflict - Update domain failed because domain display name already exists.

Examples

Update a domain example

Sample Request

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

Sample Response

Status code:

200

{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "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.
UpdateDomainRequest	The request payload for updating a domain.

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.

UpdateDomainRequest

The request payload for updating a domain.

Name	Type	Description
contributorsScope	ContributorsScopeType	The domain contributors scope.
description	string	The domain description. The description cannot contain more than 256 characters.
displayName	string	The domain display name. The display name cannot contain more than 40 characters.