Domains - Assign Domain Workspaces By Ids

  • Reference
Service:
Admin
API Version:
v1

Note

This API is in preview.

Assign workspaces to the specified domain by workspace ID.

Preexisting domain assignments will be overridden unless bulk reassignment is blocked by domain management tenant settings.

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

Tenant.ReadWrite.All.

Limitations

Maximum 10 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 No
Managed identities No

Interface

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

URI Parameters

Name In Required Type Description
domainId
 path True

string

uuid

The domain ID.

Request Body

Name Type Description
workspacesIds

string[]

Responses

Name Type Description
200 OK

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Assign domain workspaces example

Sample request

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

{
  "workspacesIds": [
    "e8de1852-7382-480a-8404-d5b1f5e1ab65",
    "5348d3a9-c096-4074-9083-09e3ca69c8e5",
    "ac561643-c5c5-4cf1-868e-8755a90e6fa3"
  ]
}

Sample response

Status code:
200

Definitions

Name Description
AssignDomainWorkspacesByIdsRequest

The request payload for assigning workspaces to a domain by workspace ID.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

AssignDomainWorkspacesByIdsRequest

The request payload for assigning workspaces to a domain by workspace ID.

Name Type Description
workspacesIds

string[]

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.