Domains - Assign Domain Workspaces By Principals

  • Reference
Service:
Admin
API Version:
v1

Note

This API is in preview.

Assign workspaces to the specified domain, when one of the specified principals has admin permission in the workspace.

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

Permissions

The caller must be a Fabric administrator.

This API supports long running operations (LRO).

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}/assignWorkspacesByPrincipals

URI Parameters

Name In Required Type Description
domainId
 path True

string

uuid

The domain ID.

Request Body

Name Type Description
principals

Principal[]

Represents an identity or a Microsoft Entra group.

Responses

Name Type Description
202 Accepted

Operation is in progress

Headers

  • Location: string
  • Retry-After: integer
  • x-ms-operation-id: string
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/assignWorkspacesByPrincipals

{
  "principals": [
    {
      "id": "796ce6ad-9163-4c16-9559-c68192a251de",
      "type": "User"
    }
  ]
}

Sample response

Status code:
202 
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 30

Definitions

Name Description
AssignDomainWorkspacesByPrincipalsRequest

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

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
GroupDetails

Group specific details. Applicable when the principal type is Group.
GroupType

The type of the group. Additional group types may be added over time.
Principal

Represents an identity or a Microsoft Entra group.
PrincipalType

The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails

Service principal specific details. Applicable when the principal type is ServicePrincipal.
ServicePrincipalProfileDetails

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
UserDetails

User principal specific details. Applicable when the principal type is User.

AssignDomainWorkspacesByPrincipalsRequest

The request payload for assigning workspaces to a domain by principal.

Name Type Description
principals

Principal[]

Represents an identity or a Microsoft Entra group.

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.

GroupDetails

Group specific details. Applicable when the principal type is Group.

Name Type Description
groupType

GroupType

The type of the group. Additional group types may be added over time.

GroupType

The type of the group. Additional group types may be added over time.

Name Type Description
DistributionList

string

Principal is a distribution list.
SecurityGroup

string

Principal is a security group.
Unknown

string

Principal group type is unknown.

Principal

Represents an identity or a Microsoft Entra group.

Name Type Description
displayName

string

The principal's display name.
groupDetails

GroupDetails

Group specific details. Applicable when the principal type is Group.
id

string

The principal's ID.
servicePrincipalDetails

ServicePrincipalDetails

Service principal specific details. Applicable when the principal type is ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
type

PrincipalType

The type of the principal. Additional principal types may be added over time.
userDetails

UserDetails

User principal specific details. Applicable when the principal type is User.

PrincipalType

The type of the principal. Additional principal types may be added over time.

Name Type Description
Group

string

Principal is a security group.
ServicePrincipal

string

Principal is a Microsoft Entra service principal.
ServicePrincipalProfile

string

Principal is a service principal profile.
User

string

Principal is a Microsoft Entra user principal.

ServicePrincipalDetails

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name Type Description
aadAppId

string

The service principal's Microsoft Entra AppId.

ServicePrincipalProfileDetails

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name Type Description
parentPrincipal

Principal

The service principal profile's parent principal.

UserDetails

User principal specific details. Applicable when the principal type is User.

Name Type Description
userPrincipalName

string

The user principal name.