Edit

Share via

Workspaces - Assign To Domain

Service:
Core
API Version:
v1

Assigns the specified workspace to the specified domain.

Permissions

  • The caller must have contributor permissions or be a domain Admin.
  • The caller must have workspace admin role.

Required Scope

Workspace.ReadWrite.All

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/assignToDomain

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
domainId True

string (uuid)

The ID of the domain the workspace should be assigned to.

Responses

Name Type Description
200 OK

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • DomainNotFound - The provided domain was not found

  • WorkspaceNotFound - The provided workspace was not found

  • InsufficientPermissionsToDomain - Caller doesn't have enough permissions to the domain to perform the operation

  • InsufficientWorkspaceRole - Caller doesn't have enough permissions to the workspace to perform the operation

  • UnknownError - An error occurred.

Examples

Assign a workspace to a domain example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/f97451ca-d6a0-482f-a46a-cc4b2c48ba56/assignToDomain

{
  "domainId": "9d04ca81-bb30-4009-bd1a-a9213a4c8d75"
}

Sample response

Status code:
200

Definitions

Name Description
AssignWorkspaceToDomainRequest

A domain assignment request.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

AssignWorkspaceToDomainRequest

Object

A domain assignment request.

Name Type Description
domainId

string (uuid)

The ID of the domain the workspace should be assigned to.

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.